You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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: 10/02/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.
azd monitor: Monitor a deployed application. (Beta)
azd package: Packages the application's code to be deployed to Azure. (Beta)
azd pipeline: Manage and configure your deployment pipelines. (Beta)
azd provision: Provision the Azure resources for an application.
azd restore: Restores the application's dependencies. (Beta)
azd show: Display information about your app and its resources.
azd template: Find and view template details. (Beta)
azd up: Provision Azure resources, and deploy your project with a single command.
azd version: Print the version number of Azure Developer CLI.
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.
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.
--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.
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.
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.
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.
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.
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.
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.
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.
--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.
--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.
--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.
--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.
--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.
--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.
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.
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.
--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.
--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.
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.
See also
azd hooks run: Runs the specified hook for the project and services
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.
See also
azd hooks: Develop, test and run hooks for an application. (Beta)
-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.
--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.
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.
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.
See also
azd pipeline config: Configure your deployment pipeline to connect securely to Azure. (Beta)
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.
See also
azd pipeline: Manage and configure your deployment pipelines. (Beta)
--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.
--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.
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.
--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.
--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.
See also
azd template: Find and view template details. (Beta)
--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.
See also
azd template: Find and view template details. (Beta)
--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.
See also
azd template: Find and view template details. (Beta)
azd template source add: Adds an azd template source with the specified key. (Beta)
The key can be any value that uniquely identifies the template source, with the exception of the following reserved, well-known key values:
・default: Default templates
・awesome-azd: Templates from http://aka.ms/awesome-azd
Adds an azd template source with the specified key. (Beta)
The key can be any value that uniquely identifies the template source, with the exception of the following reserved, well-known key values:
・default: Default templates
・awesome-azd: Templates from http://aka.ms/awesome-azd
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. Required when using type flag.
-n, --name string Display name of the template source.
-t, --type string Kind of the template source. Supported types are 'file', 'url' and 'gh'.
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.
--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.
--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.
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.
--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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Document existing environment variables in a markdown file.
Contributes to #4320