az deployment sub
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
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
The deployment name.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az deployment sub create
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
The location to store the deployment metadata.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Instruct the command to run deployment What-If before executing the deployment. It then prompts you to acknowledge resource changes before it continues.
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.
The deployment name.
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.
Property | Value |
---|---|
Default value: | False |
Accepted values: | false, true |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Default value: | False |
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.
Instruct the command to execute the deployment if the What-If result contains no resource changes. Applicable when --confirm-with-what-if is set.
The query string (a SAS token) to be used with the template-uri in the case of linked templates.
The path to the template file or Bicep file.
The template spec resource id.
The URI to the template file.
Instruct the command to run deployment What-If.
Space-separated list of resource change types to be excluded from What-If results. Applicable when --confirm-with-what-if is set.
Property | Value |
---|---|
Accepted values: | Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported |
The format of What-If results. Applicable when --confirm-with-what-if
is set.
Property | Value |
---|---|
Default value: | FullResourcePayloads |
Accepted values: | FullResourcePayloads, ResourceIdOnly |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az deployment sub delete
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
The deployment name.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az deployment sub export
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
The deployment name.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az deployment sub list
List deployments at subscription scope.
az deployment sub list [--filter]
Examples
List deployments at subscription scope.
az deployment sub list
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Filter expression using OData notation. You can use --filter "provisioningState eq '{state}'" to filter provisioningState. To get more information, please visit https://learn.microsoft.com/rest/api/resources/deployments/listatsubscriptionscope#uri-parameters.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az deployment sub show
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
The deployment name.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az deployment sub validate
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
The location to store the deployment metadata.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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.
The deployment name.
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.
Property | Value |
---|---|
Default value: | False |
Accepted values: | false, true |
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.
The query string (a SAS token) to be used with the template-uri in the case of linked templates.
The path to the template file or Bicep file.
The template spec resource id.
The URI to the template file.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
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]
[--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
The deployment name.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Wait until created with 'provisioningState' at 'Succeeded'.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Wait until deleted.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Wait until the resource exists.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Polling interval in seconds.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | 30 |
Maximum wait in seconds.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | 3600 |
Wait until updated with provisioningState at 'Succeeded'.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az deployment sub what-if
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
The location to store the deployment What-If operation metadata.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Space-separated list of resource change types to be excluded from What-If results.
Property | Value |
---|---|
Accepted values: | Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported |
The deployment name.
Disable pretty-print for What-If results. When set, the output format type will be used.
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.
Property | Value |
---|---|
Default value: | False |
Accepted values: | false, true |
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.
The query string (a SAS token) to be used with the template-uri in the case of linked templates.
The format of What-If results.
Property | Value |
---|---|
Default value: | FullResourcePayloads |
Accepted values: | FullResourcePayloads, ResourceIdOnly |
The path to the template file or Bicep file.
The template spec resource id.
The URI to the template file.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |