您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

az group deployment

管理Azure 资源管理器部署。

命令

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 为 Accepted 或 Running 时,才能取消部署。 取消部署后,provisioningState 设置为 Canceled。 取消模板部署会停止当前正在运行的模板部署,并将资源组保持为部分部署状态。

az group deployment cancel --name
                           --resource-group
                           [--subscription]

必需参数

--name -n

部署名称。

--resource-group -g

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

可选参数

--subscription

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

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]
                           [--subscription]
                           [--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-tenants

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

--handle-extended-json-format -j

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

--mode

增量 (将资源添加到资源组) 或完成 (从资源组资源组中删除) 。

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

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

--no-prompt

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

接受的值: false, true
--no-wait

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

--parameters -p

提供部署参数值。

--rollback-on-error

出错时要回滚到的部署的名称,或用作回退到上次成功部署的标志。

--subscription

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

--template-file -f

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

--template-uri -u

远程模板文件的 URI。

az group deployment delete

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

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

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

必需参数

--name -n

部署名称。

--resource-group -g

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

可选参数

--no-wait

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

--subscription

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

az group deployment export

导出用于部署的模板。

az group deployment export --name
                           --resource-group
                           [--subscription]

示例

导出用于部署的模板。 (自动生成)

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

必需参数

--name -n

部署名称。

--resource-group -g

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

可选参数

--subscription

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

az group deployment list

获取资源组的所有部署。

az group deployment list --resource-group
                         [--filter]
                         [--query-examples]
                         [--subscription]
                         [--top]

必需参数

--resource-group -g

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

可选参数

--filter

要应用于运算的筛选器。 例如,可以使用 $filter=provisioningState eq '{state}'。

--query-examples

建议使用 JMESPath 字符串。 可以复制其中一个查询并将其粘贴到 --query 参数的双引号内,以查看结果。 可以添加一个或多个位置关键字,以便我们可以基于这些关键字提供建议。

--subscription

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

--top

要获取的结果数。 如果传递 null,则返回所有部署。

az group deployment show

获取部署。

az group deployment show --name
                         --resource-group
                         [--query-examples]
                         [--subscription]

必需参数

--name -n

部署名称。

--resource-group -g

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

可选参数

--query-examples

建议使用 JMESPath 字符串。 可以复制其中一个查询并将其粘贴到 --query 参数的双引号内,以查看结果。 可以添加一个或多个位置关键字,以便我们可以基于这些关键字提供建议。

--subscription

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

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]
                             [--subscription]
                             [--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

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

--mode

增量 (将资源添加到资源组) 或完成 (从资源组资源组中删除) 。

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

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

接受的值: false, true
--parameters -p

提供部署参数值。

--rollback-on-error

出错时要回滚到的部署的名称,或用作回退到上次成功部署的标志。

--subscription

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

--template-file -f

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

--template-uri -u

远程模板文件的 URI。

az group deployment wait

将 CLI 放在等待状态,直到满足部署条件。

az group deployment wait --name
                         --resource-group
                         [--created]
                         [--custom]
                         [--deleted]
                         [--exists]
                         [--interval]
                         [--subscription]
                         [--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

等到创建时"provisioningState"位于"Succeeded"。

--custom

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

--deleted

等到删除。

--exists

等待资源存在。

--interval

轮询间隔(以秒为单位)。

默认值: 30
--subscription

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

--timeout

最大等待时间(以秒表示)。

默认值: 3600
--updated

等待,直到使用 provisioningState 更新为"Succeeded"。