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> を使用して、既定のグループを構成できます。

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
既定値: False
--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False
--parameters -p

デプロイ パラメーターの値を指定します。

--proceed-if-no-change

What-If結果にリソースの変更がない場合は、デプロイを実行するようにコマンドに指示します。 --confirm-with-what-if が設定されている場合に適用されます。

--query-string -q

リンクされたテンプレートの場合に template-uri と共に使用されるクエリ文字列 (SAS トークン)。

--rollback-on-error

エラー時にロールバックするデプロイの名前。または最後に成功したデプロイにロールバックするためのフラグとして使用します。

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

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

実行時間の長い操作の終了を待機しません。

既定値: False

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> を使用して、既定のグループを構成できます。

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ください。

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> を使用して、既定のグループを構成できます。

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
既定値: False
--parameters -p

デプロイ パラメーターの値を指定します。

--query-string -q

リンクされたテンプレートの場合に template-uri と共に使用されるクエリ文字列 (SAS トークン)。

--rollback-on-error

エラー時にロールバックするデプロイの名前。または、最後に成功したデプロイにロールバックするためのフラグとして使用します。

--template-file -f

テンプレート ファイルまたは Bicep ファイルへのパス。

--template-spec -s

テンプレート スペック リソース ID。

--template-uri -u

テンプレート ファイルの URI。

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

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

既定値: False
--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

--deleted

削除されるまで待ちます。

既定値: False
--exists

リソースが存在するまで待ちます。

既定値: False
--interval

ポーリング間隔 (秒)。

既定値: 30
--timeout

最大待機時間 (秒単位)。

既定値: 3600
--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

既定値: False

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
既定値: False
--parameters -p

デプロイ パラメーターの値を指定します。

--query-string -q

リンクされたテンプレートの場合に template-uri と共に使用されるクエリ文字列 (SAS トークン)。

--result-format -r

What-If結果の形式。

承認された値: FullResourcePayloads, ResourceIdOnly
既定値: FullResourcePayloads
--template-file -f

テンプレート ファイルまたは Bicep ファイルへのパス。

--template-spec -s

テンプレート スペック リソース ID。

--template-uri -u

テンプレート ファイルの URI。