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

az group deployment

  • 已放弃
  • 参考

此命令组已弃用，将在将来的版本中删除。 请改用“部署组”。

管理 Azure 资源管理器部署。

命令

名称 说明 类型 Status
az group deployment cancel

取消当前运行的模板部署。

 核心 已放弃
az group deployment create

启动部署。

 核心 已放弃
az group deployment delete

从部署历史记录中删除部署。

 核心 已放弃
az group deployment export

导出用于部署的模板。

 核心 已放弃
az group deployment list

获取资源组的所有部署。

 核心 已放弃
az group deployment operation

管理部署操作。

 核心 已放弃
az group deployment operation list

获取部署的所有部署操作。

 核心 已放弃
az group deployment operation show

获取部署的操作。

 核心 已放弃
az group deployment show

获取部署。

 核心 已放弃
az group deployment validate

验证模板是否语法正确。

 核心 已放弃
az group deployment wait

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

 核心 已放弃

az group deployment cancel

编辑
已放弃

此命令已隐式弃用，因为命令组“组部署”已弃用，将在将来的版本中删除。 请改用“部署组”。

取消当前运行的模板部署。

仅当 provisioningState 已接受或正在运行时，才能取消部署。 取消部署后，provisioningState 设置为“已取消”。 取消模板部署会停止当前正在运行的模板部署，并使资源组部分部署。

az group deployment cancel --name
                           --resource-group

必需参数

--name -n

部署名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

全局参数
--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 group deployment create

编辑
已放弃

此命令已隐式弃用，因为命令组“组部署”已弃用，将在将来的版本中删除。 请改用“部署组”。

启动部署。

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]

示例

使用本地 JSON 文件中的参数从远程模板文件创建部署。

az group deployment create -g MyResourceGroup --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json

使用 JSON 字符串中的参数从本地模板文件创建部署。

az group deployment create -g MyResourceGroup --template-file azuredeploy.json \
    --parameters "{ \"location\": { \"value\": \"westus\" } }"

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

az group deployment create -g MyResourceGroup --template-file azuredeploy.json \
    --parameters @params.json --parameters https://mysite/params.json --parameters MyValue=This MyArray=@array.json

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--aux-subs
已放弃

选项“--aux-subs”已弃用，将在将来的版本中删除。 请改用“--aux-tenants”。

将在跨租户部署期间使用的辅助订阅。

--aux-tenants

将在跨租户部署期间使用的辅助租户。

--handle-extended-json-format -j
已放弃

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

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

--mode

增量（仅将资源添加到资源组）或“完成”（从资源组中删除额外资源）。

接受的值: Complete, Incremental
默认值: Incremental
--name -n

部署名称。 默认为模板文件基名称。

--no-prompt

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

接受的值: false, true
默认值: False
--no-wait

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

默认值: False
--parameters -p

提供部署参数值。

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

--rollback-on-error

要回滚到错误的部署的名称，或者用作一个标志，以回滚到最后一次成功的部署。

--template-file -f

文件系统中模板文件或 Bicep 文件的路径。

--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 group deployment delete

编辑
已放弃

此命令已隐式弃用，因为命令组“组部署”已弃用，将在将来的版本中删除。 请改用“部署组”。

从部署历史记录中删除部署。

当前运行的模板部署无法删除。 删除模板部署会删除关联的部署操作。 删除模板部署不会影响资源组的状态。 这是一个异步操作，它返回状态为 202，直到模板部署成功删除。 Location 响应标头包含用于获取进程状态的 URI。 在进程运行时，对 Location 标头中的 URI 的调用将返回状态为 202。 进程完成后，Location 标头中的 URI 在成功时返回状态为 204。 如果异步请求失败，Location 标头中的 URI 将返回错误级别状态代码。

az group deployment delete --name
                           --resource-group
                           [--no-wait]

必需参数

--name -n

部署名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--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 group deployment export

编辑
已放弃

此命令已隐式弃用，因为命令组“组部署”已弃用，将在将来的版本中删除。 请改用“部署组”。

导出用于部署的模板。

az group deployment export --name
                           --resource-group

示例

导出用于部署的模板。 （自动生成）

az group deployment export --name MyDeployment --resource-group MyResourceGroup

必需参数

--name -n

部署名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

全局参数
--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 group deployment list

编辑
已放弃

此命令已隐式弃用，因为命令组“组部署”已弃用，将在将来的版本中删除。 请改用“部署组”。

获取资源组的所有部署。

az group deployment list --resource-group
                         [--filter]
                         [--top]

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--filter

要对操作应用的筛选器。 例如，可以使用 $filter=provisioningState eq “{state}”。 默认值为 None。

--top

要获取的结果数。 如果传递 null，则返回所有部署。 默认值为 None。

全局参数
--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 group deployment show

编辑
已放弃

此命令已隐式弃用，因为命令组“组部署”已弃用，将在将来的版本中删除。 请改用“部署组”。

获取部署。

az group deployment show --name
                         --resource-group

必需参数

--name -n

部署名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

全局参数
--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 group deployment validate

编辑
已放弃

此命令已隐式弃用，因为命令组“组部署”已弃用，将在将来的版本中删除。 请改用“部署组”。

验证模板是否语法正确。

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]

示例

验证模板是否语法正确。 （自动生成）

az group deployment validate --parameters "{ \"location\": { \"value\": \"westus\" } }" \
    --resource-group MyResourceGroup --template-file storage.json

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--handle-extended-json-format -j
已放弃

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

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

--mode

增量（仅将资源添加到资源组）或“完成”（从资源组中删除额外资源）。

接受的值: Complete, Incremental
默认值: Incremental
--no-prompt

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

接受的值: false, true
默认值: False
--parameters -p

提供部署参数值。

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

--rollback-on-error

要回滚到错误的部署的名称，或者用作一个标志，以回滚到最后一次成功的部署。

--template-file -f

文件系统中模板文件或 Bicep 文件的路径。

--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 group deployment wait

编辑
已放弃

此命令已隐式弃用，因为命令组“组部署”已弃用，将在将来的版本中删除。 请改用“部署组”。

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

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

示例

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

az group deployment wait --name MyDeployment --resource-group MyResourceGroup --updated

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

az group deployment wait --created --name MyDeployment --resource-group MyResourceGroup

必需参数

--name -n

部署名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--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 获取完整的调试日志。