az deployment group

管理資源群組的 Azure Resource Manager範本部署。

命令

az deployment group cancel	取消資源群組的部署。
az deployment group create	在資源群組開始部署。
az deployment group delete	刪除資源群組的部署。
az deployment group export	匯出用於某個部署的範本。
az deployment group list	列出資源群組中的部署。
az deployment group show	顯示資源群組的部署。
az deployment group validate	驗證範本是否在資源群組上有效。
az deployment group wait	將 CLI 置於等候狀態，直到符合部署條件為止。
az deployment group what-if	在資源群組範圍執行部署What-If作業。

az deployment group cancel

取消資源群組的部署。

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

範例

取消資源群組的部署。

az deployment group cancel -g testrg -n deployment01

必要參數

--name -n

部署名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用帳戶 az account set -s NAME_OR_ID 。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az deployment group create

在資源群組開始部署。

請只指定其中一個 --template-file FILE |--template-uri URI |--template-spec 以輸入 ARM 範本。

az deployment group create --resource-group
                           [--aux-subs]
                           [--aux-tenants]
                           [--confirm-with-what-if]
                           [--handle-extended-json-format]
                           [--mode {Complete, Incremental}]
                           [--name]
                           [--no-prompt {false, true}]
                           [--no-wait]
                           [--parameters]
                           [--proceed-if-no-change]
                           [--query-string]
                           [--rollback-on-error]
                           [--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 group create --resource-group testrg --name rollout01 \
    --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json

使用 JSON 字串中的參數，從本機範本檔案在資源群組建立部署。

az deployment group create --resource-group testrg --name rollout01 \
    --template-file azuredeploy.json  \
    --parameters '{ \"policyName\": { \"value\": \"policy2\" } }'

使用陣列字串中的參數，從本機範本檔案建立資源群組的部署。

az deployment group create --resource-group testgroup --template-file demotemplate.json --parameters exampleString='inline string' exampleArray='("value1", "value2")'

使用參數檔案、遠端參數檔案，以及選擇性地覆寫索引鍵/值組，從本機範本建立資源群組的部署。

az deployment group create --resource-group testrg --name rollout01 \
    --template-file azuredeploy.json  --parameters @params.json \
    --parameters https://mysite/params.json --parameters MyValue=This MyArray=@array.json

從範本規格在資源群組範圍建立部署

az deployment group create --resource-group testrg --template-spec "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Resources/templateSpecs/myTemplateSpec/versions/1.0"

必要參數

--resource-group -g

要建立部署的資源群組。

選擇性參數

--aux-subs

將在跨租使用者部署期間使用的輔助訂用帳戶。

--aux-tenants

在跨租使用者部署期間將使用的輔助租使用者。

--confirm-with-what-if -c

指示命令在執行部署之前執行部署What-If。 然後，它會提示您確認資源變更，然後再繼續。

--handle-extended-json-format -j

支援處理擴充的範本內容，包括部署中的多行和批註。

--mode

部署模式。

接受的值: Complete, Incremental

預設值: Incremental

--name -n

部署名稱。

--no-prompt

停用 ARM 範本遺漏參數提示的選項。 當值為 true 時，將會忽略要求使用者提供遺漏參數的提示。 預設值為 false。

接受的值: false, true

--no-wait

不等候長時間執行的作業完成。

--parameters -p

提供部署參數值。

--proceed-if-no-change

指示命令在What-If結果不包含任何資源變更時執行部署。 適用于設定 --confirm-with-what-if 時。

--query-string -q

查詢字串 (SAS 權杖，) 在連結範本的情況下與 template-uri 搭配使用。

--rollback-on-error

要在錯誤時復原至的部署名稱，或使用 作為旗標來回複到最後一次成功的部署。

--template-file -f

範本檔案或 Bicep 檔案的路徑。

--template-spec -s

範本規格資源識別碼。

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

輸出格式。

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用帳戶 az account set -s NAME_OR_ID 。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az deployment group delete

刪除資源群組的部署。

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

範例

刪除資源群組的部署。

az deployment group delete -g testrg -n deployment01

必要參數

--name -n

部署名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

選擇性參數

--no-wait

不等候長時間執行的作業完成。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用帳戶 az account set -s NAME_OR_ID 。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az deployment group export

匯出用於某個部署的範本。

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

範例

匯出用於資源群組之部署的範本。

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

必要參數

--name -n

部署名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用帳戶 az account set -s NAME_OR_ID 。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az deployment group list

列出資源群組中的部署。

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

範例

列出資源群組中的部署。

az deployment group list -g testrg

必要參數

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

選擇性參數

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

輸出格式。

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用帳戶 az account set -s NAME_OR_ID 。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az deployment group show

顯示資源群組的部署。

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

範例

顯示資源群組的部署。

az deployment group show -g testrg -n deployment01

必要參數

--name -n

部署名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用帳戶 az account set -s NAME_OR_ID 。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az deployment group validate

驗證範本是否在資源群組上有效。

請只指定其中一個 --template-file FILE |--template-uri URI |--template-spec 以輸入 ARM 範本。

az deployment group validate --resource-group
                             [--handle-extended-json-format]
                             [--mode {Complete, Incremental}]
                             [--name]
                             [--no-prompt {false, true}]
                             [--parameters]
                             [--query-string]
                             [--rollback-on-error]
                             [--template-file]
                             [--template-spec]
                             [--template-uri]

範例

驗證範本是否在資源群組上有效。

az deployment group validate --resource-group testrg --template-file {template-file}

驗證範本是否在資源群組上有效。 自動產生的 ()

az deployment group validate --parameters MyValue=This MyArray=@array.json --resource-group testrg --template-file azuredeploy.json

必要參數

--resource-group -g

要建立部署的資源群組。

選擇性參數

--handle-extended-json-format -j

支援處理擴充的範本內容，包括部署中的多行和批註。

--mode

部署模式。

接受的值: Complete, Incremental

預設值: Incremental

--name -n

部署名稱。

--no-prompt

停用 ARM 範本遺漏參數提示的選項。 當值為 true 時，將會忽略要求使用者提供遺漏參數的提示。 預設值為 false。

接受的值: false, true

--parameters -p

提供部署參數值。

--query-string -q

查詢字串 (SAS 權杖，) 在連結範本的情況下與 template-uri 搭配使用。

--rollback-on-error

要在錯誤時復原至的部署名稱，或使用 作為旗標來回複到最後一次成功的部署。

--template-file -f

範本檔案或 Bicep 檔案的路徑。

--template-spec -s

範本規格資源識別碼。

--template-uri -u

範本檔案的 URI。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用帳戶 az account set -s NAME_OR_ID 。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az deployment group wait

將 CLI 置於等候狀態，直到符合部署條件為止。

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

範例

將 CLI 置於等候狀態，直到符合部署條件為止。 自動產生的 ()

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

必要參數

--name -n

部署名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

選擇性參數

--created

等候在 'Succeeded' 使用 'provisioningState' 建立。

--custom

等到條件符合自訂 JMESPath 查詢為止。 例如 provisioningState！='InProgress'，instanceView.statuses[？code=='PowerState/running']。

--deleted

等到刪除為止。

--exists

等到資源存在為止。

--interval

以秒為單位輪詢間隔。

預設值: 30

--timeout

等候時間上限，以秒為單位。

預設值: 3600

--updated

等候 provisioningState 更新為 'Succeeded'。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用帳戶 az account set -s NAME_OR_ID 。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az deployment group what-if

在資源群組範圍執行部署What-If作業。

請只指定其中一個 --template-file FILE |--template-uri URI |--template-spec 以輸入 ARM 範本。

az deployment group what-if --resource-group
                            [--aux-tenants]
                            [--exclude-change-types {Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported}]
                            [--mode {Complete, Incremental}]
                            [--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 group what-if --resource-group testrg --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json

使用 ResourceIdOnly 格式，在資源群組上執行部署What-If作業。

az deployment group what-if --resource-group testrg --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --result-format ResourceIdOnly

在資源群組上執行部署What-If作業，而不需列印結果。

az deployment group what-if --resource-group testrg --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --no-pretty-print

必要參數

--resource-group -g

要執行部署What-If作業的資源群組。

選擇性參數

--aux-tenants

在跨租使用者部署期間將使用的輔助租使用者。

--exclude-change-types -x

要從結果中排除的資源變更類型空間分隔清單What-If。

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

--mode

部署模式。

接受的值: Complete, Incremental

預設值: Incremental

--name -n

部署名稱。

--no-pretty-print

停用What-If結果的美化列印。 設定時，將會使用輸出格式類型。

--no-prompt

停用 ARM 範本遺漏參數提示的選項。 當值為 true 時，將會忽略要求使用者提供遺漏參數的提示。 預設值為 false。

接受的值: false, true

--parameters -p

提供部署參數值。

--query-string -q

查詢字串 (SAS 權杖，) 在連結範本的情況下與 template-uri 搭配使用。

--result-format -r

What-If結果的格式。

接受的值: FullResourcePayloads, ResourceIdOnly

預設值: FullResourcePayloads

--template-file -f

範本檔案或 Bicep 檔案的路徑。

--template-spec -s

範本規格資源識別碼。

--template-uri -u

範本檔案的 URI。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用帳戶 az account set -s NAME_OR_ID 。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。