az deployment tenant
Manage Azure Resource Manager template deployment at tenant scope.
Name | Description | Type | Status |
---|---|---|---|
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 |
Cancel a deployment at tenant scope.
az deployment tenant cancel --name
Cancel a deployment at tenant scope.
az deployment tenant cancel -n deployment01
The deployment name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
Start a deployment at tenant scope.
Please specify only one of --template-file FILE | --template-uri URI | --template-spec to input the ARM template.
az deployment tenant 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}]
Create a deployment at tenant scope from a remote template file, using parameters from a local JSON file.
az deployment tenant create --name rollout01 --location WestUS \
--template-uri https://myresource/azuredeploy.json --parameters @myparameters.json
Create a deployment at tenant scope from a local template file, using parameters from a JSON string.
az deployment tenant create --name rollout01 --location WestUS \
--template-file azuredeploy.json \
--parameters '{ \"policyName\": { \"value\": \"policy2\" } }'
Create a deployment at tenant scope from a local template, using a parameter file, a remote parameter file, and selectively overriding key/value pairs.
az deployment tenant create --name rollout01 --location WestUS \
--template-file azuredeploy.json --parameters @params.json \
--parameters https://mysite/params.json --parameters MyValue=This MyArray=@array.json
The location to store the deployment metadata.
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.
Do not wait for the long-running operation to finish.
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.
The format of What-If results. Applicable when --confirm-with-what-if
is set.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
Delete a deployment at tenant scope.
az deployment tenant delete --name
[--no-wait]
Delete a deployment at tenant scope.
az deployment tenant delete -n deployment01
The deployment name.
Do not wait for the long-running operation to finish.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
Export the template used for a deployment.
az deployment tenant export --name
Export the template used for a deployment at tenant scope.
az deployment tenant export --name MyDeployment
The deployment name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
List deployments at tenant scope.
az deployment tenant list [--filter]
List deployments at tenant scope.
az deployment tenant list
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.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
Show a deployment at tenant scope.
az deployment tenant show --name
Show a deployment at tenant scope.
az deployment tenant show -n deployment01
The deployment name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
Validate whether a template is valid at tenant scope.
Please specify only one of --template-file FILE | --template-uri URI | --template-spec to input the ARM template.
az deployment tenant validate --location
[--handle-extended-json-format]
[--name]
[--no-prompt {false, true}]
[--parameters]
[--query-string]
[--template-file]
[--template-spec]
[--template-uri]
Validate whether a template is valid at tenant scope.
az deployment tenant validate --location WestUS --template-file {template-file}
Validate whether a template is valid at tenant scope. (autogenerated)
az deployment tenant validate --location WestUS --name mydeployment --parameters @myparameters.json --template-file azuredeploy.json
The location to store the deployment metadata.
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.
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.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
Place the CLI in a waiting state until a deployment condition is met.
az deployment tenant wait --name
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]
Place the CLI in a waiting state until a deployment condition is met. (autogenerated)
az deployment tenant wait --deleted --name MyDeployment
The deployment name.
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
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
Execute a deployment What-If operation at tenant scope.
Please specify only one of --template-file FILE | --template-uri URI | --template-spec to input the ARM template.
az deployment tenant 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]
Execute a deployment What-If operation at tenant scope.
az deployment tenant what-if --location WestUS --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json
Execute a deployment What-If operation at tenant scope with ResourceIdOnly format.
az deployment tenant what-if --location WestUS --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --result-format ResourceIdOnly
Execute a deployment What-If operation at tenant scope without pretty-printing the result.
az deployment tenant what-if --location WestUS --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --no-pretty-print
The location to store the deployment What-If operation metadata.
Space-separated list of resource change types to be excluded from What-If results.
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.
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.
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.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
Azure CLI feedback
Azure CLI is an open source project. Select a link to provide feedback: