Add ability to load azd env vars into shell by jongio · Pull Request #4078 · Azure/azure-dev

jongio · 2024-07-05T23:03:26Z

Currently adds -o export to get-values. We are evaluating other methods / interfaces as well.

source <(azd env get-values -o export)
python.py

jongio · 2024-07-08T22:00:16Z

@pamelafox - Once we get a build of azd for this PR can you try it out to see if that helps with your env path scenario?

jongio · 2024-07-09T20:42:26Z

@pamelafox - I also added a new export option to get-values that allows you to eval and set the context. For example:

azd env get-values -o export

will output:

export AZURE_LOCATION=eastus2
export AZD_PIPELINE_PROVIDER=github
export AZURE_ENV_NAME=jong-fast-test-api-2

So, you can now do:

source <(azd env get-values -o export)
python.py

app.py

import os

def print_azure_env_name():
    azure_env_name = os.getenv('AZURE_ENV_NAME')
    if azure_env_name is not None:
        print(f"AZURE_ENV_NAME: {azure_env_name}")
    else:
        print("AZURE_ENV_NAME environment variable is not set.")

if __name__ == "__main__":
    print_azure_env_name()

And that will display the value from the python app.

AZURE_ENV_NAME: jong-fast-test-api-2

I'm thinking this will work well for apps that have a startup script like a package.json or a python setup file.

I think this will do away with this type of code: https://github.com/Azure-Samples/azure-search-openai-demo/blob/main/scripts/load_azd_env.sh

pamelafox · 2024-07-09T22:40:21Z

I would be too afraid to use the -export option, as I keep getting into nasty situations due to lingering exported environment variables from previous exports (like from load_azd_env). I'm trying to move away from export in all the repos now.
Maybe theres some situation where it wouldnt lead to tainting the env?

pamelafox · 2024-07-09T22:52:48Z

I've tried this out, and it works well for the positive case, but for the case that nothing satifies the JMESpath query, it seems to give back the string "null" as a result. Is that expected? Feels a bit odd.

jongio · 2024-07-10T17:32:06Z

I would be too afraid to use the -export option, as I keep getting into nasty situations due to lingering exported environment variables from previous exports (like from load_azd_env). I'm trying to move away from export in all the repos now. Maybe theres some situation where it wouldnt lead to tainting the env?

I'd like to hear more details on what you are facing with exports.

pamelafox · 2024-07-10T17:40:54Z

@jongio When I export the whole environment, and then I do an "azd env set" to another environment, the previous env variables are still around, so my subsequent actions are affected by anything that was set there (particular anything that main.parameters.json or my hooks use). I have to then explicitly unset every variable to get things back to a clean state.

azure-sdk · 2024-07-12T15:42:22Z

Azure Dev CLI Install Instructions

Install scripts

MacOS/Linux

May elevate using sudo on some platforms and configurations

bash:

curl -fsSL https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/4078/uninstall-azd.sh | bash;
curl -fsSL https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/4078/install-azd.sh | bash -s -- --base-url https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/4078 --version '' --verbose --skip-verify

pwsh:

Invoke-RestMethod 'https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/4078/uninstall-azd.ps1' -OutFile uninstall-azd.ps1; ./uninstall-azd.ps1
Invoke-RestMethod 'https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/4078/install-azd.ps1' -OutFile install-azd.ps1; ./install-azd.ps1 -BaseUrl 'https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/4078' -Version '' -SkipVerify -Verbose

Windows

PowerShell install

powershell -c "Set-ExecutionPolicy Bypass Process; irm 'https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/4078/uninstall-azd.ps1' > uninstall-azd.ps1; ./uninstall-azd.ps1;"
powershell -c "Set-ExecutionPolicy Bypass Process; irm 'https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/4078/install-azd.ps1' > install-azd.ps1; ./install-azd.ps1 -BaseUrl 'https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/4078' -Version '' -SkipVerify -Verbose;"

MSI install

powershell -c "irm 'https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/4078/azd-windows-amd64.msi' -OutFile azd-windows-amd64.msi; msiexec /i azd-windows-amd64.msi /qn"

Standalone Binary

MSI

x86_64 - https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/4078/azd-windows-amd64.msi

Documentation

learn.microsoft.com documentation

title: Azure Developer CLI reference
description: This article explains the syntax and parameters for the various Azure Developer CLI commands.
author: alexwolfmsft
ms.author: alexwolf
ms.date: 07/11/2024
ms.service: azure-dev-cli
ms.topic: conceptual
ms.custom: devx-track-azdevcli

Azure Developer CLI reference

This article explains the syntax and parameters for the various Azure Developer CLI commands.

azd

The Azure Developer CLI (azd) is an open-source tool that helps onboard and manage your application on Azure

Options

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --docs           Opens the documentation for azd in your web browser.
  -h, --help           Gets help for azd.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd auth

Authenticate with Azure.

Options

      --docs   Opens the documentation for azd auth in your web browser.
  -h, --help   Gets help for auth.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd auth login

Log in to Azure.

Synopsis

Log in to Azure.

When run without any arguments, log in interactively using a browser. To log in using a device code, pass
--use-device-code.

To log in as a service principal, pass --client-id and --tenant-id as well as one of: --client-secret,
--client-certificate, or --federated-credential-provider.

To log in using a managed identity, pass --managed-identity, which will use the system assigned managed identity.
To use a user assigned managed identity, pass --client-id in addition to --managed-identity with the client id of
the user assigned managed identity you wish to use.

azd auth login [flags]

Options

      --check-status                           Checks the log-in status instead of logging in.
      --client-certificate string              The path to the client certificate for the service principal to authenticate with.
      --client-id string                       The client id for the service principal to authenticate with.
      --client-secret string                   The client secret for the service principal to authenticate with. Set to the empty string to read the value from the console.
      --docs                                   Opens the documentation for azd auth login in your web browser.
      --federated-credential-provider string   The provider to use to acquire a federated token to authenticate with.
  -h, --help                                   Gets help for login.
      --managed-identity                       Use a managed identity to authenticate.
      --redirect-port int                      Choose the port to be used as part of the redirect URI during interactive login.
      --tenant-id string                       The tenant id or domain name to authenticate with.
      --use-device-code[=true]                 When true, log in by using a device code instead of a browser.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd auth logout

Log out of Azure.

Synopsis

Log out of Azure

azd auth logout [flags]

Options

      --docs   Opens the documentation for azd auth logout in your web browser.
  -h, --help   Gets help for logout.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd config

Manage azd configurations (ex: default Azure subscription, location).

Synopsis

Manage the Azure Developer CLI user configuration, which includes your default Azure subscription and location.

Available since azure-dev-cli_0.4.0-beta.1.

The easiest way to configure azd for the first time is to run azd init. The subscription and location you select will be stored in the config.json file located in the config directory. To configure azd anytime afterwards, you'll use azd config set.

The default value of the config directory is:

$HOME/.azd on Linux and macOS
%USERPROFILE%.azd on Windows

The configuration directory can be overridden by specifying a path in the AZD_CONFIG_DIR environment variable.

Options

      --docs   Opens the documentation for azd config in your web browser.
  -h, --help   Gets help for config.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd config get

Gets a configuration.

Synopsis

Gets a configuration in the configuration path.

The default value of the config directory is:

$HOME/.azd on Linux and macOS
%USERPROFILE%\.azd on Windows

The configuration directory can be overridden by specifying a path in the AZD_CONFIG_DIR environment variable.

azd config get <path> [flags]

Options

      --docs   Opens the documentation for azd config get in your web browser.
  -h, --help   Gets help for get.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd config list-alpha

Display the list of available features in alpha stage.

azd config list-alpha [flags]

Options

      --docs   Opens the documentation for azd config list-alpha in your web browser.
  -h, --help   Gets help for list-alpha.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd config reset

Resets configuration to default.

Synopsis

Resets all configuration in the configuration path.

The default value of the config directory is:

$HOME/.azd on Linux and macOS
%USERPROFILE%\.azd on Windows

The configuration directory can be overridden by specifying a path in the AZD_CONFIG_DIR environment variable to the default.

azd config reset [flags]

Options

      --docs    Opens the documentation for azd config reset in your web browser.
  -f, --force   Force reset without confirmation.
  -h, --help    Gets help for reset.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd config set

Sets a configuration.

Synopsis

Sets a configuration in the configuration path.

The default value of the config directory is:

$HOME/.azd on Linux and macOS
%USERPROFILE%\.azd on Windows

The configuration directory can be overridden by specifying a path in the AZD_CONFIG_DIR environment variable.

azd config set <path> <value> [flags]

Examples

azd config set defaults.subscription <yourSubscriptionID>
azd config set defaults.location eastus

Options

      --docs   Opens the documentation for azd config set in your web browser.
  -h, --help   Gets help for set.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd config show

Show all the configuration values.

Synopsis

Show all configuration values in the configuration path.

The default value of the config directory is:

$HOME/.azd on Linux and macOS
%USERPROFILE%\.azd on Windows

The configuration directory can be overridden by specifying a path in the AZD_CONFIG_DIR environment variable.

azd config show [flags]

Options

      --docs   Opens the documentation for azd config show in your web browser.
  -h, --help   Gets help for show.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd config unset

Unsets a configuration.

Synopsis

Removes a configuration in the configuration path.

The default value of the config directory is:

$HOME/.azd on Linux and macOS
%USERPROFILE%\.azd on Windows

The configuration directory can be overridden by specifying a path in the AZD_CONFIG_DIR environment variable.

azd config unset <path> [flags]

Examples

azd config unset defaults.location

Options

      --docs   Opens the documentation for azd config unset in your web browser.
  -h, --help   Gets help for unset.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd deploy

Deploy the application's code to Azure.

azd deploy <service> [flags]

Options

      --all                   Deploys all services that are listed in azure.yaml
      --docs                  Opens the documentation for azd deploy in your web browser.
  -e, --environment string    The name of the environment to use.
      --from-package string   Deploys the application from an existing package.
  -h, --help                  Gets help for deploy.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd down

Delete Azure resources for an application.

azd down [flags]

Options

      --docs                 Opens the documentation for azd down in your web browser.
  -e, --environment string   The name of the environment to use.
      --force                Does not require confirmation before it deletes resources.
  -h, --help                 Gets help for down.
      --purge                Does not require confirmation before it permanently deletes resources that are soft-deleted by default (for example, key vaults).

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd env

Manage environments.

Options

      --docs   Opens the documentation for azd env in your web browser.
  -h, --help   Gets help for env.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd env get-value

Get specific environment value.

azd env get-value <keyName> [flags]

Options

      --docs                 Opens the documentation for azd env get-value in your web browser.
  -e, --environment string   The name of the environment to use.
  -h, --help                 Gets help for get-value.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd env get-values

Get all environment values.

azd env get-values [flags]

Options

      --docs                 Opens the documentation for azd env get-values in your web browser.
  -e, --environment string   The name of the environment to use.
  -h, --help                 Gets help for get-values.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd env list

List environments.

azd env list [flags]

Options

      --docs   Opens the documentation for azd env list in your web browser.
  -h, --help   Gets help for list.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd env new

Create a new environment and set it as the default.

azd env new <environment> [flags]

Options

      --docs                  Opens the documentation for azd env new in your web browser.
  -h, --help                  Gets help for new.
  -l, --location string       Azure location for the new environment
      --subscription string   Name or ID of an Azure subscription to use for the new environment

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd env refresh

Refresh environment settings by using information from a previous infrastructure provision.

azd env refresh <environment> [flags]

Options

      --docs                 Opens the documentation for azd env refresh in your web browser.
  -e, --environment string   The name of the environment to use.
  -h, --help                 Gets help for refresh.
      --hint string          Hint to help identify the environment to refresh

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd env select

Set the default environment.

azd env select <environment> [flags]

Options

      --docs   Opens the documentation for azd env select in your web browser.
  -h, --help   Gets help for select.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd env set

Manage your environment settings.

azd env set <key> <value> [flags]

Options

      --docs                 Opens the documentation for azd env set in your web browser.
  -e, --environment string   The name of the environment to use.
  -h, --help                 Gets help for set.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd hooks

Develop, test and run hooks for an application. (Beta)

Options

      --docs   Opens the documentation for azd hooks in your web browser.
  -h, --help   Gets help for hooks.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd hooks run

Runs the specified hook for the project and services

azd hooks run <name> [flags]

Options

      --docs                 Opens the documentation for azd hooks run in your web browser.
  -e, --environment string   The name of the environment to use.
  -h, --help                 Gets help for run.
      --platform string      Forces hooks to run for the specified platform.
      --service string       Only runs hooks for the specified service.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd init

Initialize a new application.

azd init [flags]

Options

  -b, --branch string         The template branch to initialize from. Must be used with a template argument (--template or -t).
      --docs                  Opens the documentation for azd init in your web browser.
  -e, --environment string    The name of the environment to use.
  -f, --filter strings        The tag(s) used to filter template results. Supports comma-separated values.
      --from-code             Initializes a new application from your existing code.
  -h, --help                  Gets help for init.
  -l, --location string       Azure location for the new environment
  -s, --subscription string   Name or ID of an Azure subscription to use for the new environment
  -t, --template string       Initializes a new application from a template. You can use Full URI, <owner>/<repository>, or <repository> if it's part of the azure-samples organization.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd monitor

Monitor a deployed application. (Beta)

azd monitor [flags]

Options

      --docs                 Opens the documentation for azd monitor in your web browser.
  -e, --environment string   The name of the environment to use.
  -h, --help                 Gets help for monitor.
      --live                 Open a browser to Application Insights Live Metrics. Live Metrics is currently not supported for Python apps.
      --logs                 Open a browser to Application Insights Logs.
      --overview             Open a browser to Application Insights Overview Dashboard.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd package

Packages the application's code to be deployed to Azure. (Beta)

azd package <service> [flags]

Options

      --all                  Packages all services that are listed in azure.yaml
      --docs                 Opens the documentation for azd package in your web browser.
  -e, --environment string   The name of the environment to use.
  -h, --help                 Gets help for package.
      --output-path string   File or folder path where the generated packages will be saved.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd pipeline

Manage and configure your deployment pipelines. (Beta)

Options

      --docs   Opens the documentation for azd pipeline in your web browser.
  -h, --help   Gets help for pipeline.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd pipeline config

Configure your deployment pipeline to connect securely to Azure. (Beta)

azd pipeline config [flags]

Options

  -m, --applicationServiceManagementReference string   Service Management Reference. References application or service contact information from a Service or Asset Management database. This value must be a Universally Unique Identifier (UUID). You can set this value globally by running azd config set pipeline.config.applicationServiceManagementReference <UUID>.
      --auth-type string                               The authentication type used between the pipeline provider and Azure for deployment (Only valid for GitHub provider). Valid values: federated, client-credentials.
      --docs                                           Opens the documentation for azd pipeline config in your web browser.
  -e, --environment string                             The name of the environment to use.
  -h, --help                                           Gets help for config.
      --principal-id string                            The client id of the service principal to use to grant access to Azure resources as part of the pipeline.
      --principal-name string                          The name of the service principal to use to grant access to Azure resources as part of the pipeline.
      --principal-role stringArray                     The roles to assign to the service principal. By default the service principal will be granted the Contributor and User Access Administrator roles. (default [Contributor,User Access Administrator])
      --provider string                                The pipeline provider to use (github for Github Actions and azdo for Azure Pipelines).
      --remote-name string                             The name of the git remote to configure the pipeline to run on. (default "origin")

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd provision

Provision the Azure resources for an application.

azd provision [flags]

Options

      --docs                 Opens the documentation for azd provision in your web browser.
  -e, --environment string   The name of the environment to use.
  -h, --help                 Gets help for provision.
      --no-state             Do not use latest Deployment State (bicep only).
      --preview              Preview changes to Azure resources.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd restore

Restores the application's dependencies. (Beta)

azd restore <service> [flags]

Options

      --all                  Restores all services that are listed in azure.yaml
      --docs                 Opens the documentation for azd restore in your web browser.
  -e, --environment string   The name of the environment to use.
  -h, --help                 Gets help for restore.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd show

Display information about your app and its resources.

azd show [flags]

Options

      --docs                 Opens the documentation for azd show in your web browser.
  -e, --environment string   The name of the environment to use.
  -h, --help                 Gets help for show.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd template

Find and view template details. (Beta)

Options

      --docs   Opens the documentation for azd template in your web browser.
  -h, --help   Gets help for template.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd template list

Show list of sample azd templates. (Beta)

azd template list [flags]

Options

      --docs             Opens the documentation for azd template list in your web browser.
  -f, --filter strings   The tag(s) used to filter template results. Supports comma-separated values.
  -h, --help             Gets help for list.
  -s, --source string    Filters templates by source.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd template show

Show details for a given template. (Beta)

azd template show <template> [flags]

Options

      --docs   Opens the documentation for azd template show in your web browser.
  -h, --help   Gets help for show.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd template source

View and manage template sources. (Beta)

Options

      --docs   Opens the documentation for azd template source in your web browser.
  -h, --help   Gets help for source.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd template source add

Adds an azd template source at the specified key (Beta)

azd template source add <key> [flags]

Options

      --docs              Opens the documentation for azd template source add in your web browser.
  -h, --help              Gets help for add.
  -l, --location string   Location of the template source.
  -n, --name string       Display name of the template source.
  -t, --type string       Kind of the template source.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd template source list

Lists the configured azd template sources. (Beta)

azd template source list [flags]

Options

      --docs   Opens the documentation for azd template source list in your web browser.
  -h, --help   Gets help for list.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd template source remove

Removes the specified azd template source (Beta)

azd template source remove <key> [flags]

Options

      --docs   Opens the documentation for azd template source remove in your web browser.
  -h, --help   Gets help for remove.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd up

Provision Azure resources, and deploy your project with a single command.

azd up [flags]

Options

      --docs                 Opens the documentation for azd up in your web browser.
  -e, --environment string   The name of the environment to use.
  -h, --help                 Gets help for up.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

azd version

Print the version number of Azure Developer CLI.

azd version [flags]

Options

      --docs   Opens the documentation for azd version in your web browser.
  -h, --help   Gets help for version.

Options inherited from parent commands

  -C, --cwd string     Sets the current working directory.
      --debug          Enables debugging and diagnostics logging.
      --no-prompt      Accepts the default value instead of prompting, or it fails if there is no default.
  -q, --query string   Run jmespath query on results

Uh oh!

Conversation

jongio commented Jul 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jongio commented Jul 8, 2024

Uh oh!

jongio commented Jul 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pamelafox commented Jul 9, 2024

Uh oh!

pamelafox commented Jul 9, 2024

Uh oh!

jongio commented Jul 10, 2024

Uh oh!

pamelafox commented Jul 10, 2024

Uh oh!

azure-sdk commented Jul 12, 2024

Azure Dev CLI Install Instructions

Install scripts

MacOS/Linux

Windows

Standalone Binary

MSI

Documentation

title: Azure Developer CLI reference description: This article explains the syntax and parameters for the various Azure Developer CLI commands. author: alexwolfmsft ms.author: alexwolf ms.date: 07/11/2024 ms.service: azure-dev-cli ms.topic: conceptual ms.custom: devx-track-azdevcli

Azure Developer CLI reference

azd

Options

See also

azd auth

Options

Options inherited from parent commands

See also

azd auth login

Synopsis

Options

Options inherited from parent commands

See also

azd auth logout

Synopsis

Options

Options inherited from parent commands

See also

azd config

Synopsis

Options

Options inherited from parent commands

See also

azd config get

Synopsis

Options

Options inherited from parent commands

See also

azd config list-alpha

Options

Options inherited from parent commands

See also

azd config reset

Synopsis

Options

Options inherited from parent commands

See also

azd config set

Synopsis

Examples

Options

Options inherited from parent commands

See also

azd config show

Synopsis

Options

Options inherited from parent commands

See also

azd config unset

Synopsis

Examples

Options

Options inherited from parent commands

jongio commented Jul 5, 2024 •

edited

Loading

jongio commented Jul 9, 2024 •

edited

Loading

title: Azure Developer CLI reference
description: This article explains the syntax and parameters for the various Azure Developer CLI commands.
author: alexwolfmsft
ms.author: alexwolf
ms.date: 07/11/2024
ms.service: azure-dev-cli
ms.topic: conceptual
ms.custom: devx-track-azdevcli