az deployment sub

  • Reference

Manage Azure Resource Manager template deployment at subscription scope.

Commands

Name Description Type Status
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 sub cancel

Edit

Cancel a deployment at subscription scope.

az deployment sub cancel --name

Examples

Cancel a deployment at subscription scope.

az deployment sub cancel -n deployment01

Required Parameters

--name -n

The deployment name.

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 sub create

Edit

Start a deployment at subscription scope.

Please specify only one of --template-file FILE | --template-uri URI | --template-spec to input the ARM template.

az deployment sub 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 sub 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 sub 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 sub create --location WestUS --template-file azuredeploy.json  \
    --parameters @params.json --parameters https://mysite/params.json --parameters MyValue=This MyArray=@array.json

Required Parameters

--location -l

The location to store the deployment metadata.

Optional Parameters

--confirm-with-what-if -c

Instruct the command to run deployment What-If before executing the deployment. It then prompts you to acknowledge resource changes before it continues.

--handle-extended-json-format -j
Deprecated

Option '--handle-extended-json-format/-j' has been deprecated and will be removed in a future release.

Support to handle extended template content including multiline and comments in deployment.

--name -n

The deployment name.

--no-prompt

The option to disable the prompt of missing parameters for ARM template. When the value is true, the prompt requiring users to provide missing parameter will be ignored. The default value is false.

accepted values: false, true
default value: False
--no-wait

Do not wait for the long-running operation to finish.

default value: False
--parameters -p

Supply deployment parameter values.

Parameters may be supplied from a file using the @{path} syntax, a JSON string, or as <KEY=VALUE> pairs. Parameters are evaluated in order, so when a value is assigned twice, the latter value will be used. It is recommended that you supply your parameters file first, and then override selectively using KEY=VALUE syntax.

--proceed-if-no-change

Instruct the command to execute the deployment if the What-If result contains no resource changes. Applicable when --confirm-with-what-if is set.

--query-string -q

The query string (a SAS token) to be used with the template-uri in the case of linked templates.

--template-file -f

The path to the template file or Bicep file.

--template-spec -s

The template spec resource id.

--template-uri -u

The URI to the template file.

--what-if -w

Instruct the command to run deployment What-If.

--what-if-exclude-change-types -x

Space-separated list of resource change types to be excluded from What-If results. Applicable when --confirm-with-what-if is set.

accepted values: Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported
--what-if-result-format -r

The format of What-If results. Applicable when --confirm-with-what-if is set.

accepted values: FullResourcePayloads, ResourceIdOnly
default value: FullResourcePayloads
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 sub delete

Edit

Delete a deployment at subscription scope.

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

Examples

Delete a deployment at subscription scope.

az deployment sub delete -n deployment01

Required Parameters

--name -n

The deployment name.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

default value: False
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 sub export

Edit

Export the template used for a deployment.

az deployment sub export --name

Examples

Export the template used for a deployment at subscription scope.

az deployment sub export --name MyDeployment

Required Parameters

--name -n

The deployment name.

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 sub list

Edit

List deployments at subscription scope.

az deployment sub list [--filter]

Examples

List deployments at subscription scope.

az deployment sub list

Optional Parameters

--filter
Preview

Filter expression using OData notation. You can use --filter "provisioningState eq '{state}'" to filter provisioningState. To get more information, please visit https://docs.microsoft.com/rest/api/resources/deployments/listatsubscriptionscope#uri-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 sub show

Edit

Show a deployment at subscription scope.

az deployment sub show --name

Examples

Show a deployment at subscription scope.

az deployment sub show -n deployment01

Required Parameters

--name -n

The deployment name.

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 sub validate

Edit

Validate whether a template is valid at subscription scope.

Please specify only one of --template-file FILE | --template-uri URI | --template-spec to input the ARM template.

az deployment sub 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 sub validate --location westus2 --template-file {template-file}

Validate whether a template is valid at subscription scope. (autogenerated)

az deployment sub validate --location westus2 --parameters MyValue=This MyArray=@array.json --template-file azuredeploy.json

Required Parameters

--location -l

The location to store the deployment metadata.

Optional Parameters

--handle-extended-json-format -j
Deprecated

Option '--handle-extended-json-format/-j' has been deprecated and will be removed in a future release.

Support to handle extended template content including multiline and comments in deployment.

--name -n

The deployment name.

--no-prompt

The option to disable the prompt of missing parameters for ARM template. When the value is true, the prompt requiring users to provide missing parameter will be ignored. The default value is false.

accepted values: false, true
default value: False
--parameters -p

Supply deployment parameter values.

Parameters may be supplied from a file using the @{path} syntax, a JSON string, or as <KEY=VALUE> pairs. Parameters are evaluated in order, so when a value is assigned twice, the latter value will be used. It is recommended that you supply your parameters file first, and then override selectively using KEY=VALUE syntax.

--query-string -q

The query string (a SAS token) to be used with the template-uri in the case of linked templates.

--template-file -f

The path to the template file or Bicep file.

--template-spec -s

The template spec resource id.

--template-uri -u

The URI to the template file.

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 sub wait

Edit

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

az deployment sub 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 sub wait --created --name MyDeployment

Required Parameters

--name -n

The deployment name.

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

default value: False
--exists

Wait until the resource exists.

default value: False
--interval

Polling interval in seconds.

default value: 30
--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

default value: False
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 sub what-if

Edit

Execute a deployment What-If operation at subscription scope.

Please specify only one of --template-file FILE | --template-uri URI | --template-spec to input the ARM template.

az deployment sub what-if --location
                          [--exclude-change-types {Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported}]
                          [--name]
                          [--no-pretty-print]
                          [--no-prompt {false, true}]
                          [--parameters]
                          [--query-string]
                          [--result-format {FullResourcePayloads, ResourceIdOnly}]
                          [--template-file]
                          [--template-spec]
                          [--template-uri]

Examples

Execute a deployment What-If operation at a subscription.

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

Execute a deployment What-If operation at a subscription with ResourceIdOnly format.

az deployment sub what-if --location WestUS --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --result-format ResourceIdOnly

Execute a deployment What-If operation at a subscription without pretty-printing the result.

az deployment sub what-if --location WestUS --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --no-pretty-print

Required Parameters

--location -l

The location to store the deployment What-If operation metadata.

Optional Parameters

--exclude-change-types -x

Space-separated list of resource change types to be excluded from What-If results.

accepted values: Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported
--name -n

The deployment name.

--no-pretty-print

Disable pretty-print for What-If results. When set, the output format type will be used.

--no-prompt

The option to disable the prompt of missing parameters for ARM template. When the value is true, the prompt requiring users to provide missing parameter will be ignored. The default value is false.

accepted values: false, true
default value: False
--parameters -p

Supply deployment parameter values.

Parameters may be supplied from a file using the @{path} syntax, a JSON string, or as <KEY=VALUE> pairs. Parameters are evaluated in order, so when a value is assigned twice, the latter value will be used. It is recommended that you supply your parameters file first, and then override selectively using KEY=VALUE syntax.

--query-string -q

The query string (a SAS token) to be used with the template-uri in the case of linked templates.

--result-format -r

The format of What-If results.

accepted values: FullResourcePayloads, ResourceIdOnly
default value: FullResourcePayloads
--template-file -f

The path to the template file or Bicep file.

--template-spec -s

The template spec resource id.

--template-uri -u

The URI to the template file.

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.