id = "azure-dev"
name = "Azure Developer CLI"
homepage = "https://aka.ms/azd"
executables = ["azd"]
[dotfiles]
paths = ["~/.azd/config.json"]
exclude = []
secret = ["~/.azd/vaults/*.json"]
[commands]
format = 1
label = "Azure Developer CLI"
description = "Initialize, provision, deploy and tear down an azd project. Environment management, pipeline, template and auth commands are left out."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }
[[commands.subcommand]]
path = ["up"]
label = "Provision and deploy"
[[commands.subcommand.source]]
id = "ref"
kind = "manual"
url = "https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/reference"
revision = "2026-10-27"
evidence = '''
azd up [flags]
-e, --environment string The name of the environment to use.
-l, --location string Azure location for the new environment
--subscription string ID of an Azure subscription to use for the new environment
-C, --cwd string Sets the current working directory.
--debug Enables debugging and diagnostics logging.
--no-prompt Runs without prompts. Uses existing values; fails if any required value or decision cannot be resolved automatically.
'''
[[commands.subcommand.field]]
id = "environment"
label = "Environment"
description = "Name of the environment to use."
type = "string"
option = ["--environment", "-e"]
sources = ["ref"]
[[commands.subcommand.field]]
id = "location"
label = "Azure location"
type = "string"
option = ["--location", "-l"]
sources = ["ref"]
[[commands.subcommand.field]]
id = "subscription"
label = "Subscription ID"
type = "string"
option = ["--subscription"]
sources = ["ref"]
[[commands.subcommand.field]]
id = "cwd"
label = "Working directory"
type = "path"
option = ["--cwd", "-C"]
path = { kind = "directory", role = "input" }
sources = ["ref"]
[[commands.subcommand.field]]
id = "no_prompt"
label = "Run without prompts"
type = "boolean"
option = ["--no-prompt"]
sources = ["ref"]
[[commands.subcommand.task]]
id = "up"
label = "Provision and deploy"
fields = ["environment", "location", "subscription", "no_prompt"]
required = []
[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["environment", "location", "subscription"]
[[commands.subcommand.group]]
id = "advanced"
label = "Advanced"
fields = ["cwd", "no_prompt"]
[[commands.subcommand]]
path = ["init"]
label = "Initialize a project"
[[commands.subcommand.source]]
id = "ref"
kind = "manual"
url = "https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/reference"
revision = "2026-10-27"
evidence = '''
azd init [flags]
-b, --branch string The template branch to initialize from. Must be used with a template argument (--template or -t).
-e, --environment string The name of the environment to use.
--from-code Initializes a new application from your existing code.
-l, --location string Azure location for the new environment
-m, --minimal Initializes a minimal project.
-s, --subscription string ID of an Azure subscription to use for the new environment
-t, --template string Initializes a new application from a template. You can use a Full URI, <owner>/<repository>, <repository> if it's part of the azure-samples organization, or a local directory path (./dir, ../dir, or absolute path).
--up Provision and deploy to Azure after initializing the project from a template.
-C, --cwd string Sets the current working directory.
--debug Enables debugging and diagnostics logging.
--no-prompt Runs without prompts. Uses existing values; fails if any required value or decision cannot be resolved automatically.
'''
[[commands.subcommand.field]]
id = "template"
label = "Template"
description = "Full URI, owner/repository, or a local directory path."
type = "string"
option = ["--template", "-t"]
sources = ["ref"]
[[commands.subcommand.field]]
id = "branch"
label = "Template branch"
description = "Use together with a template."
type = "string"
option = ["--branch", "-b"]
sources = ["ref"]
[[commands.subcommand.field]]
id = "from_code"
label = "Initialize from existing code"
type = "boolean"
option = ["--from-code"]
sources = ["ref"]
[[commands.subcommand.field]]
id = "minimal"
label = "Minimal project"
type = "boolean"
option = ["--minimal", "-m"]
sources = ["ref"]
[[commands.subcommand.field]]
id = "environment"
label = "Environment"
description = "Name of the environment to use."
type = "string"
option = ["--environment", "-e"]
sources = ["ref"]
[[commands.subcommand.field]]
id = "location"
label = "Azure location"
type = "string"
option = ["--location", "-l"]
sources = ["ref"]
[[commands.subcommand.field]]
id = "subscription"
label = "Subscription ID"
type = "string"
option = ["--subscription", "-s"]
sources = ["ref"]
[[commands.subcommand.field]]
id = "up"
label = "Provision and deploy afterwards"
description = "Only after initializing from a template."
type = "boolean"
option = ["--up"]
sources = ["ref"]
[[commands.subcommand.field]]
id = "cwd"
label = "Working directory"
type = "path"
option = ["--cwd", "-C"]
path = { kind = "directory", role = "input" }
sources = ["ref"]
[[commands.subcommand.field]]
id = "no_prompt"
label = "Run without prompts"
type = "boolean"
option = ["--no-prompt"]
sources = ["ref"]
[[commands.subcommand.task]]
id = "from_template"
label = "From a template"
fields = ["template", "branch", "environment", "up"]
required = ["template"]
[[commands.subcommand.task]]
id = "from_code"
label = "From existing code"
set = { from_code = [true] }
fields = ["from_code", "environment"]
required = []
[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["template", "from_code", "environment", "up"]
[[commands.subcommand.group]]
id = "advanced"
label = "Advanced"
fields = ["branch", "minimal", "location", "subscription", "cwd", "no_prompt"]
[[commands.subcommand]]
path = ["provision"]
label = "Provision Azure resources"
[[commands.subcommand.source]]
id = "ref"
kind = "manual"
url = "https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/reference"
revision = "2026-10-27"
evidence = '''
azd provision [<layer>] [flags]
-e, --environment string The name of the environment to use.
-l, --location string Azure location for the new environment
--no-state (Bicep only) Forces a fresh deployment based on current Bicep template files, ignoring any stored deployment state.
--preview Preview changes to Azure resources.
--subscription string ID of an Azure subscription to use for the new environment
-C, --cwd string Sets the current working directory.
--debug Enables debugging and diagnostics logging.
--no-prompt Runs without prompts. Uses existing values; fails if any required value or decision cannot be resolved automatically.
'''
[[commands.subcommand.field]]
id = "layer"
label = "Layer"
description = "Optional provisioning layer."
type = "string"
position = 0
sources = ["ref"]
[[commands.subcommand.field]]
id = "preview"
label = "Preview changes only"
type = "boolean"
option = ["--preview"]
sources = ["ref"]
[[commands.subcommand.field]]
id = "environment"
label = "Environment"
description = "Name of the environment to use."
type = "string"
option = ["--environment", "-e"]
sources = ["ref"]
[[commands.subcommand.field]]
id = "location"
label = "Azure location"
type = "string"
option = ["--location", "-l"]
sources = ["ref"]
[[commands.subcommand.field]]
id = "subscription"
label = "Subscription ID"
type = "string"
option = ["--subscription"]
sources = ["ref"]
[[commands.subcommand.field]]
id = "no_state"
label = "Ignore stored deployment state"
description = "Bicep only."
type = "boolean"
option = ["--no-state"]
sources = ["ref"]
[[commands.subcommand.field]]
id = "cwd"
label = "Working directory"
type = "path"
option = ["--cwd", "-C"]
path = { kind = "directory", role = "input" }
sources = ["ref"]
[[commands.subcommand.field]]
id = "no_prompt"
label = "Run without prompts"
type = "boolean"
option = ["--no-prompt"]
sources = ["ref"]
[[commands.subcommand.task]]
id = "provision"
label = "Provision"
fields = ["environment", "location", "subscription"]
required = []
[[commands.subcommand.task]]
id = "preview"
label = "Preview changes"
set = { preview = [true] }
fields = ["environment", "preview"]
required = []
[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["layer", "environment", "location", "subscription", "preview"]
[[commands.subcommand.group]]
id = "advanced"
label = "Advanced"
fields = ["no_state", "cwd", "no_prompt"]
[[commands.subcommand]]
path = ["deploy"]
label = "Deploy services"
[[commands.subcommand.source]]
id = "ref"
kind = "manual"
url = "https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/reference"
revision = "2026-10-27"
evidence = '''
azd deploy <service> [flags]
--all Deploys all services that are listed in azure.yaml
-e, --environment string The name of the environment to use.
--from-package string Deploys the packaged service located at the provided path. Supports zipped file packages (file path) or container images (image tag).
--preview Preview changes to services without deploying them.
--timeout int Maximum time in seconds for azd to wait for each service deployment.
-C, --cwd string Sets the current working directory.
--debug Enables debugging and diagnostics logging.
--no-prompt Runs without prompts. Uses existing values; fails if any required value or decision cannot be resolved automatically.
'''
[[commands.subcommand.field]]
id = "service"
label = "Service"
description = "Name of the service to deploy."
type = "string"
position = 0
sources = ["ref"]
[[commands.subcommand.field]]
id = "all"
label = "Deploy all services"
type = "boolean"
option = ["--all"]
sources = ["ref"]
[[commands.subcommand.field]]
id = "environment"
label = "Environment"
description = "Name of the environment to use."
type = "string"
option = ["--environment", "-e"]
sources = ["ref"]
[[commands.subcommand.field]]
id = "preview"
label = "Preview changes only"
type = "boolean"
option = ["--preview"]
sources = ["ref"]
[[commands.subcommand.field]]
id = "from_package"
label = "Deploy a package"
description = "Path to a zipped package, or a container image tag."
type = "string"
option = ["--from-package"]
sources = ["ref"]
[[commands.subcommand.field]]
id = "timeout"
label = "Timeout per service (seconds)"
type = "integer"
option = ["--timeout"]
sources = ["ref"]
[[commands.subcommand.field]]
id = "cwd"
label = "Working directory"
type = "path"
option = ["--cwd", "-C"]
path = { kind = "directory", role = "input" }
sources = ["ref"]
[[commands.subcommand.field]]
id = "no_prompt"
label = "Run without prompts"
type = "boolean"
option = ["--no-prompt"]
sources = ["ref"]
[[commands.subcommand.task]]
id = "one"
label = "Deploy one service"
fields = ["service", "environment"]
required = ["service"]
[[commands.subcommand.task]]
id = "all"
label = "Deploy all services"
set = { all = [true] }
fields = ["all", "environment"]
required = []
[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["service", "all", "environment", "preview"]
[[commands.subcommand.group]]
id = "advanced"
label = "Advanced"
fields = ["from_package", "timeout", "cwd", "no_prompt"]
[[commands.subcommand]]
path = ["down"]
label = "Delete Azure resources"
[[commands.subcommand.source]]
id = "ref"
kind = "manual"
url = "https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/reference"
revision = "2026-10-27"
evidence = '''
azd down [<layer>] [flags]
-e, --environment string The name of the environment to use.
--force Does not require confirmation before it deletes resources.
--purge Does not require confirmation before it permanently deletes resources that are soft-deleted by default (for example, key vaults).
-C, --cwd string Sets the current working directory.
--debug Enables debugging and diagnostics logging.
--no-prompt Runs without prompts. Uses existing values; fails if any required value or decision cannot be resolved automatically.
'''
[[commands.subcommand.field]]
id = "layer"
label = "Layer"
description = "Optional layer."
type = "string"
position = 0
sources = ["ref"]
[[commands.subcommand.field]]
id = "environment"
label = "Environment"
description = "Name of the environment to use."
type = "string"
option = ["--environment", "-e"]
sources = ["ref"]
[[commands.subcommand.field]]
id = "force"
label = "Skip delete confirmation"
type = "boolean"
option = ["--force"]
effect = "delete"
sources = ["ref"]
[[commands.subcommand.field]]
id = "purge"
label = "Purge soft-deleted resources"
description = "Permanently deletes resources such as key vaults."
type = "boolean"
option = ["--purge"]
effect = "delete"
sources = ["ref"]
[[commands.subcommand.field]]
id = "cwd"
label = "Working directory"
type = "path"
option = ["--cwd", "-C"]
path = { kind = "directory", role = "input" }
sources = ["ref"]
[[commands.subcommand.field]]
id = "no_prompt"
label = "Run without prompts"
type = "boolean"
option = ["--no-prompt"]
sources = ["ref"]
[[commands.subcommand.task]]
id = "down"
label = "Delete resources"
fields = ["layer", "environment"]
required = []
[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["layer", "environment"]
[[commands.subcommand.group]]
id = "advanced"
label = "Advanced"
fields = ["force", "purge", "cwd", "no_prompt"]
