az deployment

Commands

Name	Description	Type	Status
az deployment cancel	Cancel a deployment at subscription scope.	Core	Deprecated
az deployment create	Start a deployment at subscription scope.	Core	Deprecated
az deployment delete	Delete a deployment at subscription scope.	Core	Deprecated
az deployment export	Export the template used for a deployment.	Core	Deprecated
az deployment group	Manage Azure Resource Manager template deployment at resource group.	Core	GA
az deployment group cancel	Cancel a deployment at resource group.	Core	GA
az deployment group create	Start a deployment at resource group.	Core	GA
az deployment group delete	Delete a deployment at resource group.	Core	GA
az deployment group export	Export the template used for a deployment.	Core	GA
az deployment group list	List deployments at resource group.	Core	GA
az deployment group show	Show a deployment at resource group.	Core	GA
az deployment group validate	Validate whether a template is valid at resource group.	Core	GA
az deployment group wait	Place the CLI in a waiting state until a deployment condition is met.	Core	GA
az deployment group what-if	Execute a deployment What-If operation at resource group scope.	Core	GA
az deployment list	List deployments at subscription scope.	Core	Deprecated
az deployment mg	Manage Azure Resource Manager template deployment at management group.	Core	GA
az deployment mg cancel	Cancel a deployment at management group.	Core	GA
az deployment mg create	Start a deployment at management group.	Core	GA
az deployment mg delete	Delete a deployment at management group.	Core	GA
az deployment mg export	Export the template used for a deployment.	Core	GA
az deployment mg list	List deployments at management group.	Core	GA
az deployment mg show	Show a deployment at management group.	Core	GA
az deployment mg validate	Validate whether a template is valid at management group.	Core	GA
az deployment mg wait	Place the CLI in a waiting state until a deployment condition is met.	Core	GA
az deployment mg what-if	Execute a deployment What-If operation at management group scope.	Core	GA
az deployment operation	Manage deployment operations at subscription scope.	Core	GA
az deployment operation group	Manage deployment operations at resource group.	Core	GA
az deployment operation group list	List deployment operations at resource group.	Core	GA
az deployment operation group show	Show a deployment operation at resource group.	Core	GA
az deployment operation list	List deployment operations at subscription scope.	Core	Deprecated
az deployment operation mg	Manage deployment operations at management group.	Core	GA
az deployment operation mg list	List deployment operations at management group.	Core	GA
az deployment operation mg show	Show a deployment operation at management group.	Core	GA
az deployment operation show	Show a deployment operation at subscription scope.	Core	Deprecated
az deployment operation sub	Manage deployment operations at subscription scope.	Core	GA
az deployment operation sub list	List deployment operations at subscription scope.	Core	GA
az deployment operation sub show	Show a deployment operation at subscription scope.	Core	GA
az deployment operation tenant	Manage deployment operations at tenant scope.	Core	GA
az deployment operation tenant list	List deployment operations at tenant scope.	Core	GA
az deployment operation tenant show	Show a deployment operation at tenant scope.	Core	GA
az deployment show	Show a deployment at subscription scope.	Core	Deprecated
az deployment sub	Manage Azure Resource Manager template deployment at subscription scope.	Core	GA
az deployment sub cancel	Cancel a deployment at subscription scope.	Core	GA
az deployment sub create	Start a deployment at subscription scope.	Core	GA
az deployment sub delete	Delete a deployment at subscription scope.	Core	GA
az deployment sub export	Export the template used for a deployment.	Core	GA
az deployment sub list	List deployments at subscription scope.	Core	GA
az deployment sub show	Show a deployment at subscription scope.	Core	GA
az deployment sub validate	Validate whether a template is valid at subscription scope.	Core	GA
az deployment sub wait	Place the CLI in a waiting state until a deployment condition is met.	Core	GA
az deployment sub what-if	Execute a deployment What-If operation at subscription scope.	Core	GA
az deployment tenant	Manage Azure Resource Manager template deployment at tenant scope.	Core	GA
az deployment tenant cancel	Cancel a deployment at tenant scope.	Core	GA
az deployment tenant create	Start a deployment at tenant scope.	Core	GA
az deployment tenant delete	Delete a deployment at tenant scope.	Core	GA
az deployment tenant export	Export the template used for a deployment.	Core	GA
az deployment tenant list	List deployments at tenant scope.	Core	GA
az deployment tenant show	Show a deployment at tenant scope.	Core	GA
az deployment tenant validate	Validate whether a template is valid at tenant scope.	Core	GA
az deployment tenant wait	Place the CLI in a waiting state until a deployment condition is met.	Core	GA
az deployment tenant what-if	Execute a deployment What-If operation at tenant scope.	Core	GA
az deployment validate	Validate whether a template is valid at subscription scope.	Core	Deprecated
az deployment wait	Place the CLI in a waiting state until a deployment condition is met.	Core	Deprecated

az deployment cancel --name

Examples

Cancel a deployment at subscription scope.

az deployment cancel -n deployment01

Required Parameters

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az deployment create --location
                     [--confirm-with-what-if]
                     [--handle-extended-json-format]
                     [--name]
                     [--no-prompt {false, true}]
                     [--no-wait]
                     [--parameters]
                     [--proceed-if-no-change]
                     [--query-string]
                     [--template-file]
                     [--template-spec]
                     [--template-uri]
                     [--what-if]
                     [--what-if-exclude-change-types {Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported}]
                     [--what-if-result-format {FullResourcePayloads, ResourceIdOnly}]

Examples

Create a deployment at subscription scope from a remote template file, using parameters from a local JSON file.

az deployment create --location WestUS --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json

Create a deployment at subscription scope from a local template file, using parameters from a JSON string.

az deployment create --location WestUS --template-file azuredeploy.json  \
    --parameters "{ \"policyName\": { \"value\": \"policy2\" }}"

Create a deployment at subscription scope from a local template, using a parameter file, a remote parameter file, and selectively overriding key/value pairs.

az deployment create --location WestUS --template-file azuredeploy.json  \
    --parameters @params.json --parameters https://mysite/params.json --parameters MyValue=This [email protected]

Create a deployment at subscription scope from a template-spec

az deployment create --location WestUS --template-spec "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Resources/templateSpecs/myTemplateSpec/versions/1.0"

Required Parameters

Optional Parameters

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az deployment delete --name
                     [--no-wait]

Examples

Delete a deployment at subscription scope.

az deployment delete -n deployment01

Required Parameters

Optional Parameters

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az deployment export --name

Examples

Export the template used for a deployment at subscription scope.

az deployment export --name MyDeployment

Required Parameters

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az deployment list [--filter]

Examples

List deployments at subscription scope.

az deployment list

Optional Parameters

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az deployment show --name

Examples

Show a deployment at subscription scope.

az deployment show -n deployment01

Required Parameters

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az deployment validate --location
                       [--handle-extended-json-format]
                       [--name]
                       [--no-prompt {false, true}]
                       [--parameters]
                       [--query-string]
                       [--template-file]
                       [--template-spec]
                       [--template-uri]

Examples

Validate whether a template is valid at subscription scope.

az deployment validate --location westus2 --parameters MyValue=This [email protected] --template-file azuredeploy.json

Required Parameters

Optional Parameters

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az deployment wait --name
                   [--created]
                   [--custom]
                   [--deleted]
                   [--exists]
                   [--interval]
                   [--timeout]
                   [--updated]

Examples

Place the CLI in a waiting state until a deployment condition is met. (autogenerated)

az deployment wait --deleted --name MyDeployment --subscription MySubscription

Required Parameters

Optional Parameters

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.