az deployment sub

Manage Azure Resource Manager template deployment at subscription scope.

Commands

az deployment sub cancel

Cancel a deployment at subscription scope.

az deployment sub create

Start a deployment at subscription scope.

az deployment sub delete

Delete a deployment at subscription scope.

az deployment sub export

Export the template used for a deployment.

az deployment sub list

List deployments at subscription scope.

az deployment sub show

Show a deployment at subscription scope.

az deployment sub validate

Validate whether a template is valid at subscription scope.

az deployment sub wait

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

az deployment sub what-if

Execute a deployment What-If operation at subscription scope.

az deployment sub cancel

Cancel a deployment at subscription scope.

az deployment sub cancel --name
                         [--subscription]

Examples

Cancel a deployment at subscription scope.

az deployment sub cancel -n deployment01

Required Parameters

--name -n

The deployment name.

Optional Parameters

--subscription

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

az deployment sub create

Start a deployment at subscription scope.

az deployment sub create --location
                         [--confirm-with-what-if]
                         [--handle-extended-json-format]
                         [--name]
                         [--no-prompt {false, true}]
                         [--no-wait]
                         [--parameters]
                         [--subscription]
                         [--template-file]
                         [--template-uri]
                         [--what-if-exclude-change-types {Create, Delete, Deploy, Ignore, Modify, NoChange}]
                         [--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

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

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

--parameters -p

Supply deployment parameter values.

--subscription

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

--template-file -f

The path to the template file.

--template-uri -u

The URI to the template file.

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

az deployment sub delete

Delete a deployment at subscription scope.

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

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.

--subscription

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

az deployment sub export

Export the template used for a deployment.

az deployment sub export --name
                         [--subscription]

Examples

Export the template used for a deployment at subscription scope.

az deployment sub export --name MyDeployment

Required Parameters

--name -n

The deployment name.

Optional Parameters

--subscription

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

az deployment sub list

List deployments at subscription scope.

az deployment sub list [--filter]
                       [--subscription]

Examples

List deployments at subscription scope.

az deployment sub list

Optional Parameters

--filter

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/en-us/rest/api/resources/deployments/listatsubscriptionscope#uri-parameters.

--subscription

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

az deployment sub show

Show a deployment at subscription scope.

az deployment sub show --name
                       [--subscription]

Examples

Show a deployment at subscription scope.

az deployment sub show -n deployment01

Required Parameters

--name -n

The deployment name.

Optional Parameters

--subscription

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

az deployment sub validate

Validate whether a template is valid at subscription scope.

az deployment sub validate --location
                           [--handle-extended-json-format]
                           [--name]
                           [--no-prompt {false, true}]
                           [--parameters]
                           [--subscription]
                           [--template-file]
                           [--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

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
--parameters -p

Supply deployment parameter values.

--subscription

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

--template-file -f

The path to the template file.

--template-uri -u

The URI to the template file.

az deployment sub wait

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

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

Examples

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

az deployment sub wait --name MyDeployment --created

Required Parameters

--name -n

The deployment name.

Optional Parameters

--created

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

--custom

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

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--interval

Polling interval in seconds.

default value: 30
--subscription

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

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

az deployment sub what-if

Execute a deployment What-If operation at subscription scope.

az deployment sub what-if --location
                          [--exclude-change-types {Create, Delete, Deploy, Ignore, Modify, NoChange}]
                          [--name]
                          [--no-pretty-print]
                          [--no-prompt {false, true}]
                          [--parameters]
                          [--result-format {FullResourcePayloads, ResourceIdOnly}]
                          [--subscription]
                          [--template-file]
                          [--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
--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
--parameters -p

Supply deployment parameter values.

--result-format -r

The format of What-If results.

accepted values: FullResourcePayloads, ResourceIdOnly
default value: FullResourcePayloads
--subscription

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

--template-file -f

The path to the template file.

--template-uri -u

The URI to the template file.