你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az deployment tenant

在租户范围内管理 Azure 资源管理器模板部署。

命令

名称	说明	类型	状态
az deployment tenant cancel	取消租户范围内的部署。	核心	GA
az deployment tenant create	在租户范围内启动部署。	核心	GA
az deployment tenant delete	删除租户范围内的部署。	核心	GA
az deployment tenant export	导出用于部署的模板。	核心	GA
az deployment tenant list	列出租户范围内的部署。	核心	GA
az deployment tenant show	在租户范围内显示部署。	核心	GA
az deployment tenant validate	验证模板在租户范围内是否有效。	核心	GA
az deployment tenant wait	将 CLI 置于等待状态，直到满足部署条件。	核心	GA
az deployment tenant what-if	在租户范围内执行部署 What-If 操作。	核心	GA

az deployment tenant cancel

取消租户范围内的部署。

az deployment tenant cancel --name

示例

取消租户范围内的部署。

az deployment tenant cancel -n deployment01

必需参数

--name -n

部署名称。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az deployment tenant create

在租户范围内启动部署。

请仅指定一个 --template-file 文件 |--template-uri URI |--template-spec，用于输入 ARM 模板。

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

示例

使用本地 JSON 文件中的参数，从远程模板文件在租户范围内创建部署。

az deployment tenant create --name rollout01 --location WestUS \
    --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json

使用 JSON 字符串中的参数，从本地模板文件在租户范围内创建部署。

az deployment tenant create --name rollout01 --location WestUS \
    --template-file azuredeploy.json \
    --parameters '{ \"policyName\": { \"value\": \"policy2\" } }'

使用参数文件、远程参数文件以及选择性地重写键/值对，从本地模板在租户范围内创建部署。

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

必需参数

--location -l

用于存储部署元数据的位置。

可选参数

--confirm-with-what-if -c

指示命令在执行部署之前运行部署 What-If。 然后，它会提示你确认资源更改，然后再继续。

--handle-extended-json-format -j

已放弃

选项“--handle-extended-json-format/-j”已弃用，将在将来的版本中删除。

支持处理扩展模板内容，包括部署中的多行和注释。

--name -n

部署名称。

--no-prompt

禁用 ARM 模板缺少参数提示的选项。 如果值为 true，则会忽略要求用户提供缺失参数的提示。 默认值为 false。

接受的值: false, true

默认值: False

--no-wait

不等待长时间运行的操作完成。

默认值: False

--parameters -p

提供部署参数值。

可以使用语法、JSON 字符串或 <KEY=VALUE> 对从文件@{path}提供参数。 参数按顺序计算，因此在为值分配两次时，将使用后一个值。 建议先提供参数文件，然后使用 KEY=VALUE 语法选择性地替代参数文件。

--proceed-if-no-change

指示命令在 What-If 结果不包含任何资源更改时执行部署。 在设置 --confirm-with-what-if 时适用。

--query-string -q

在链接模板的情况下，要与模板 URI 一起使用的查询字符串（SAS 令牌）。

--template-file -f

模板文件或 Bicep 文件的路径。

--template-spec -s

模板规格资源 ID。

--template-uri -u

模板文件的 URI。

--what-if -w

指示命令运行部署 What-If。

--what-if-exclude-change-types -x

要从 What-If 结果中排除的资源更改类型的空格分隔列表。 在设置 --confirm-with-what-if 时适用。

接受的值: Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported

--what-if-result-format -r

What-If 结果的格式。 设置时 --confirm-with-what-if 适用。

接受的值: FullResourcePayloads, ResourceIdOnly

默认值: FullResourcePayloads

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az deployment tenant delete

删除租户范围内的部署。

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

示例

删除租户范围内的部署。

az deployment tenant delete -n deployment01

必需参数

--name -n

部署名称。

可选参数

--no-wait

不等待长时间运行的操作完成。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az deployment tenant export

导出用于部署的模板。

az deployment tenant export --name

示例

导出用于租户范围内的部署的模板。

az deployment tenant export --name MyDeployment

必需参数

--name -n

部署名称。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az deployment tenant list

列出租户范围内的部署。

az deployment tenant list [--filter]

示例

列出租户范围内的部署。

az deployment tenant list

可选参数

--filter

预览

使用 OData 表示法筛选表达式。 可以使用 --filter “provisioningState eq '{state}'”筛选 provisioningState。 若要获取详细信息，请访问 https://docs.microsoft.com/rest/api/resources/deployments/listatsubscriptionscope#uri-parameters。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az deployment tenant show

在租户范围内显示部署。

az deployment tenant show --name

示例

在租户范围内显示部署。

az deployment tenant show -n deployment01

必需参数

--name -n

部署名称。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az deployment tenant validate

验证模板在租户范围内是否有效。

请仅指定一个 --template-file 文件 |--template-uri URI |--template-spec，用于输入 ARM 模板。

az deployment tenant validate --location
                              [--handle-extended-json-format]
                              [--name]
                              [--no-prompt {false, true}]
                              [--parameters]
                              [--query-string]
                              [--template-file]
                              [--template-spec]
                              [--template-uri]

示例

验证模板在租户范围内是否有效。

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

验证模板在租户范围内是否有效。 （自动生成）

az deployment tenant validate --location WestUS --name mydeployment --parameters @myparameters.json --template-file azuredeploy.json

必需参数

--location -l

用于存储部署元数据的位置。

可选参数

--handle-extended-json-format -j

已放弃

选项“--handle-extended-json-format/-j”已弃用，将在将来的版本中删除。

支持处理扩展模板内容，包括部署中的多行和注释。

--name -n

部署名称。

--no-prompt

禁用 ARM 模板缺少参数提示的选项。 如果值为 true，则会忽略要求用户提供缺失参数的提示。 默认值为 false。

接受的值: false, true

默认值: False

--parameters -p

提供部署参数值。

可以使用语法、JSON 字符串或 <KEY=VALUE> 对从文件@{path}提供参数。 参数按顺序计算，因此在为值分配两次时，将使用后一个值。 建议先提供参数文件，然后使用 KEY=VALUE 语法选择性地替代参数文件。

--query-string -q

在链接模板的情况下，要与模板 URI 一起使用的查询字符串（SAS 令牌）。

--template-file -f

模板文件或 Bicep 文件的路径。

--template-spec -s

模板规格资源 ID。

--template-uri -u

模板文件的 URI。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az deployment tenant wait

将 CLI 置于等待状态，直到满足部署条件。

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

示例

将 CLI 置于等待状态，直到满足部署条件。 （自动生成）

az deployment tenant wait --deleted --name MyDeployment

必需参数

--name -n

部署名称。

可选参数

--created

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False

--custom

等待条件满足自定义 JMESPath 查询。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False

--exists

等待资源存在。

默认值: False

--interval

轮询间隔（以秒为单位）。

默认值: 30

--timeout

最大等待（以秒为单位）。

默认值: 3600

--updated

等到 provisioningState 更新为“Succeeded”。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az deployment tenant what-if

在租户范围内执行部署 What-If 操作。

请仅指定一个 --template-file 文件 |--template-uri URI |--template-spec，用于输入 ARM 模板。

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]

示例

在租户范围内执行部署 What-If 操作。

az deployment tenant what-if --location WestUS --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json

使用 ResourceIdOnly 格式在租户范围内执行部署 What-If 操作。

az deployment tenant what-if --location WestUS --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --result-format ResourceIdOnly

在不打印结果的情况下在租户范围内执行部署 What-If 操作。

az deployment tenant what-if --location WestUS --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --no-pretty-print

必需参数

--location -l

用于存储部署 What-If 操作元数据的位置。

可选参数

--exclude-change-types -x

要从 What-If 结果中排除的资源更改类型的空格分隔列表。

接受的值: Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported

--name -n

部署名称。

--no-pretty-print

为 What-If 结果禁用漂亮的打印。 设置后，将使用输出格式类型。

--no-prompt

禁用 ARM 模板缺少参数提示的选项。 如果值为 true，则会忽略要求用户提供缺失参数的提示。 默认值为 false。

接受的值: false, true

默认值: False

--parameters -p

提供部署参数值。

可以使用语法、JSON 字符串或 <KEY=VALUE> 对从文件@{path}提供参数。 参数按顺序计算，因此在为值分配两次时，将使用后一个值。 建议先提供参数文件，然后使用 KEY=VALUE 语法选择性地替代参数文件。

--query-string -q

在链接模板的情况下，要与模板 URI 一起使用的查询字符串（SAS 令牌）。

--result-format -r

What-If 结果的格式。

接受的值: FullResourcePayloads, ResourceIdOnly

默认值: FullResourcePayloads

--template-file -f

模板文件或 Bicep 文件的路径。

--template-spec -s

模板规格资源 ID。

--template-uri -u

模板文件的 URI。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。