az deployment group

リファレンス

リソースグループで Azure Resource Manager テンプレートのデプロイを管理します。

コマンド

名前	説明	型	Status
az deployment group cancel	リソースグループでのデプロイを取り消します。	コア	GA
az deployment group create	リソースグループでデプロイを開始します。	コア	GA
az deployment group delete	リソースグループでデプロイを削除します。	コア	GA
az deployment group export	デプロイに使用されたテンプレートをエクスポートします。	コア	GA
az deployment group list	リソースグループでのデプロイを一覧表示します。	コア	GA
az deployment group show	リソースグループでのデプロイを表示します。	コア	GA
az deployment group validate	リソースグループでテンプレートが有効かどうかを検証します。	コア	GA
az deployment group wait	デプロイ条件が満たされるまで、CLI を待機状態にします。	コア	GA
az deployment group what-if	リソースグループスコープでデプロイの What-If 操作を実行します。	コア	GA

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

出力形式。

承認された値: 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 group create

編集

リソースグループでデプロイを開始します。

--template-file FILE の 1 つだけを指定してください |--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"

bicepparam パラメーターファイルからリソースグループスコープでデプロイを作成する

az deployment group create --resource-group testrg --parameters parameters.bicepparam

テナント間でリソースグループにデプロイを作成する

az deployment group create --resource-group testrg --name rollout01 \
    --template-file azuredeploy.json --parameters @myparameters.json --aux-tenants auxiliary_tenant01 auxiliary_tenant02

必須のパラメーター

--resource-group -g

デプロイを作成するリソースグループ。

省略可能のパラメーター

--aux-subs

非推奨

オプション '--aux-subs' は非推奨となり、今後のリリースで削除される予定です。代わりに '--aux-tenants' を使用してください。

テナント間でのデプロイ中に使用される補助サブスクリプション。

--aux-tenants

テナント間でのデプロイ時に使用される補助テナント。

--confirm-with-what-if -c

デプロイを実行する前に、デプロイ What-If を実行するようにコマンドに指示します。続ける前に、リソースの変更を確認するように求められます。

--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}から指定できます。パラメーターは順番に評価されるため、値が 2 回割り当てられると、後者の値が使用されます。最初にパラメーターファイルを指定してから、KEY=VALUE 構文を使用して選択的にオーバーライドすることをお勧めします。また、bicepparam ファイルを指定する場合は、この引数を 1 回だけ使用できます。

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

グローバルパラメーター

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

グローバルパラメーター

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

出力形式。

承認された値: 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 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

出力形式。

承認された値: 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 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

出力形式。

承認された値: 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 group validate

編集

リソースグループでテンプレートが有効かどうかを検証します。

--template-file FILE の 1 つだけを指定してください |--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

非推奨

オプション '--handle-extended-json-format/-j' は非推奨となり、今後のリリースで削除される予定です。

デプロイでの複数行やコメントを含む拡張テンプレートコンテンツの処理をサポートします。

--mode

展開モード。

承認された値: Complete, Incremental

既定値: Incremental

--name -n

デプロイ名。

--no-prompt

承認された値: 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。

グローバルパラメーター

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

グローバルパラメーター

--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 group what-if

編集

リソースグループスコープでデプロイの What-If 操作を実行します。

--template-file FILE の 1 つだけを指定してください |--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

承認された値: 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。

グローバルパラメーター

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

コマンド

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

例

必須のパラメーター

省略可能のパラメーター

az deployment group what-if

例

必須のパラメーター

省略可能のパラメーター

フィードバック

その他のリソース