az group deployment
This command group has been deprecated and will be removed in a future release. Use 'deployment group' instead.
Manage Azure Resource Manager deployments.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az group deployment cancel |
Cancels a currently running template deployment. |
Core | Deprecated |
| az group deployment create |
Start a deployment. |
Core | Deprecated |
| az group deployment delete |
Deletes a deployment from the deployment history. |
Core | Deprecated |
| az group deployment export |
Export the template used for a deployment. |
Core | Deprecated |
| az group deployment list |
Get all the deployments for a resource group. |
Core | Deprecated |
| az group deployment operation |
Manage deployment operations. |
Core | Deprecated |
| az group deployment operation list |
Gets all deployments operations for a deployment. |
Core | Deprecated |
| az group deployment operation show |
Get a deployment's operation. |
Core | Deprecated |
| az group deployment show |
Gets a deployment. |
Core | Deprecated |
| az group deployment validate |
Validate whether a template is syntactically correct. |
Core | Deprecated |
| az group deployment wait |
Place the CLI in a waiting state until a deployment condition is met. |
Core | Deprecated |
az group deployment cancel
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Cancels a currently running template deployment.
You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resource group partially deployed.
az group deployment cancel --name
--resource-groupRequired Parameters
The deployment name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Increase logging verbosity to show all debug logs.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Show this help message and exit.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Only show errors, suppressing warnings.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Output format.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
JMESPath query string. See http://jmespath.org/ for more information and examples.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Increase logging verbosity. Use --debug for full debug logs.
az group deployment create
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Start a deployment.
az group deployment create --resource-group
[--aux-subs]
[--aux-tenants]
[--handle-extended-json-format]
[--mode {Complete, Incremental}]
[--name]
[--no-prompt {false, true}]
[--no-wait]
[--parameters]
[--rollback-on-error]
[--template-file]
[--template-uri]Examples
Create a deployment from a remote template file, using parameters from a local JSON file.
az group deployment create -g MyResourceGroup --template-uri https://myresource/azuredeploy.json --parameters @myparameters.jsonCreate a deployment from a local template file, using parameters from a JSON string.
az group deployment create -g MyResourceGroup --template-file azuredeploy.json \
--parameters "{ \"location\": { \"value\": \"westus\" } }"Create a deployment from a local template, using a local parameter file, a remote parameter file, and selectively overriding key/value pairs.
az group deployment create -g MyResourceGroup --template-file azuredeploy.json \
--parameters @params.json --parameters https://mysite/params.json --parameters MyValue=This MyArray=@array.jsonRequired Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Option '--aux-subs' has been deprecated and will be removed in a future release. Use '--aux-tenants' instead.
Auxiliary subscriptions which will be used during deployment across tenants.
Auxiliary tenants which will be used during deployment across tenants.
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.
Incremental (only add resources to resource group) or Complete (remove extra resources from resource group).
The deployment name. Default to template file base 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.
Do not wait for the long-running operation to finish.
Supply deployment parameter values.
The name of a deployment to roll back to on error, or use as a flag to roll back to the last successful deployment.
A path to a template file or Bicep file in the file system.
A uri to a remote template file.
Global Parameters
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Increase logging verbosity to show all debug logs.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Show this help message and exit.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Only show errors, suppressing warnings.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Output format.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
JMESPath query string. See http://jmespath.org/ for more information and examples.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Increase logging verbosity. Use --debug for full debug logs.
az group deployment delete
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Deletes a deployment from the deployment history.
A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. Deleting a template deployment does not affect the state of the resource group. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.
az group deployment delete --name
--resource-group
[--no-wait]Required Parameters
The deployment name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Do not wait for the long-running operation to finish.
Global Parameters
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Increase logging verbosity to show all debug logs.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Show this help message and exit.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Only show errors, suppressing warnings.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Output format.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
JMESPath query string. See http://jmespath.org/ for more information and examples.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Increase logging verbosity. Use --debug for full debug logs.
az group deployment export
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Export the template used for a deployment.
az group deployment export --name
--resource-groupExamples
Export the template used for a deployment. (autogenerated)
az group deployment export --name MyDeployment --resource-group MyResourceGroupRequired Parameters
The deployment name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Increase logging verbosity to show all debug logs.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Show this help message and exit.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Only show errors, suppressing warnings.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Output format.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
JMESPath query string. See http://jmespath.org/ for more information and examples.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Increase logging verbosity. Use --debug for full debug logs.
az group deployment list
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Get all the deployments for a resource group.
az group deployment list --resource-group
[--filter]
[--top]Required Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'. Default value is None.
The number of results to get. If null is passed, returns all deployments. Default value is None.
Global Parameters
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Increase logging verbosity to show all debug logs.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Show this help message and exit.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Only show errors, suppressing warnings.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Output format.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
JMESPath query string. See http://jmespath.org/ for more information and examples.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Increase logging verbosity. Use --debug for full debug logs.
az group deployment show
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Gets a deployment.
az group deployment show --name
--resource-groupRequired Parameters
The deployment name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Increase logging verbosity to show all debug logs.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Show this help message and exit.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Only show errors, suppressing warnings.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Output format.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
JMESPath query string. See http://jmespath.org/ for more information and examples.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Increase logging verbosity. Use --debug for full debug logs.
az group deployment validate
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Validate whether a template is syntactically correct.
az group deployment validate --resource-group
[--handle-extended-json-format]
[--mode {Complete, Incremental}]
[--no-prompt {false, true}]
[--parameters]
[--rollback-on-error]
[--template-file]
[--template-uri]Examples
Validate whether a template is syntactically correct. (autogenerated)
az group deployment validate --parameters "{ \"location\": { \"value\": \"westus\" } }" \
--resource-group MyResourceGroup --template-file storage.jsonRequired Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
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.
Incremental (only add resources to resource group) or Complete (remove extra resources from resource group).
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.
Supply deployment parameter values.
The name of a deployment to roll back to on error, or use as a flag to roll back to the last successful deployment.
A path to a template file or Bicep file in the file system.
A uri to a remote template file.
Global Parameters
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Increase logging verbosity to show all debug logs.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Show this help message and exit.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Only show errors, suppressing warnings.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Output format.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
JMESPath query string. See http://jmespath.org/ for more information and examples.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Increase logging verbosity. Use --debug for full debug logs.
az group deployment wait
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Place the CLI in a waiting state until a deployment condition is met.
az group deployment wait --name
--resource-group
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]Examples
Place the CLI in a waiting state until a deployment condition is met. (autogenerated)
az group deployment wait --name MyDeployment --resource-group MyResourceGroup --updatedPlace the CLI in a waiting state until a deployment condition is met. (autogenerated)
az group deployment wait --created --name MyDeployment --resource-group MyResourceGroupRequired Parameters
The deployment name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
Polling interval in seconds.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Increase logging verbosity to show all debug logs.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Show this help message and exit.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Only show errors, suppressing warnings.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Output format.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
JMESPath query string. See http://jmespath.org/ for more information and examples.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
This command is implicitly deprecated because command group 'group deployment' is deprecated and will be removed in a future release. Use 'deployment group' instead.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Submit and view feedback for