次の方法で共有


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

出力形式。

指定可能な値: 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

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

パラメーターは、@{path} 構文、JSON 文字列、または <KEY=VALUE> ペアを使用してファイルから指定できます。 パラメーターは順番に評価されるため、値が 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://learn.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

ARM テンプレートの不足しているパラメーターのプロンプトを無効にするオプション。 値が true の場合、不足しているパラメーターを指定するようユーザーに求めるプロンプトは無視されます。 既定値は false です。

指定可能な値: false, true
規定値: False
--parameters -p

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

パラメーターは、@{path} 構文、JSON 文字列、または <KEY=VALUE> ペアを使用してファイルから指定できます。 パラメーターは順番に評価されるため、値が 2 回割り当てられると、後者の値が使用されます。 最初にパラメーター ファイルを指定してから、KEY=VALUE 構文を使用して選択的にオーバーライドすることをお勧めします。

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

ARM テンプレートの不足しているパラメーターのプロンプトを無効にするオプション。 値が true の場合、不足しているパラメーターを指定するようユーザーに求めるプロンプトは無視されます。 既定値は false です。

指定可能な値: false, true
規定値: False
--parameters -p

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

パラメーターは、@{path} 構文、JSON 文字列、または <KEY=VALUE> ペアを使用してファイルから指定できます。 パラメーターは順番に評価されるため、値が 2 回割り当てられると、後者の値が使用されます。 最初にパラメーター ファイルを指定してから、KEY=VALUE 構文を使用して選択的にオーバーライドすることをお勧めします。

--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 を使用します。