az deployment tenant

Manage Azure Resource Manager template deployment at tenant scope.

Commands

az deployment tenant cancel

Cancel a deployment at tenant scope.

az deployment tenant create

Start a deployment at tenant scope.

az deployment tenant delete

Delete a deployment at tenant scope.

az deployment tenant export

Export the template used for a deployment.

az deployment tenant list

List deployments at tenant scope.

az deployment tenant show

Show a deployment at tenant scope.

az deployment tenant validate

Validate whether a template is valid at tenant scope.

az deployment tenant wait

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

az deployment tenant what-if

Execute a deployment What-If operation at tenant scope.

az deployment tenant cancel

Cancel a deployment at tenant scope.

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

Examples

Cancel a deployment at tenant scope.

az deployment tenant 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 tenant create

Start a deployment at tenant scope.

az deployment tenant 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 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

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

Delete a deployment at tenant scope.

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

Examples

Delete a deployment at tenant scope.

az deployment tenant 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 tenant export

Export the template used for a deployment.

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

Examples

Export the template used for a deployment at tenant scope.

az deployment tenant 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 tenant list

List deployments at tenant scope.

az deployment tenant list [--filter]
                          [--query-examples]
                          [--subscription]

Examples

List deployments at tenant scope.

az deployment tenant 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.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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

az deployment tenant show

Show a deployment at tenant scope.

az deployment tenant show --name
                          [--query-examples]
                          [--subscription]

Examples

Show a deployment at tenant scope.

az deployment tenant show -n deployment01

Required Parameters

--name -n

The deployment name.

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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

az deployment tenant validate

Validate whether a template is valid at tenant scope.

az deployment tenant 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 tenant scope.

az deployment tenant validate --location WestUS --template-file {template-file}

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

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

az deployment tenant 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 tenant wait --deleted --name MyDeployment

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 tenant what-if

Execute a deployment What-If operation at tenant scope.

az deployment tenant 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 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

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.