az deployment mg

管理グループで Azure Resource Manager テンプレートの展開を管理します。

コマンド

az deployment mg cancel

管理グループで展開を取り消します。

az deployment mg create

管理グループで展開を開始します。

az deployment mg delete

管理グループで展開を削除します。

az deployment mg export

デプロイに使用されたテンプレートをエクスポートします。

az deployment mg list

管理グループで展開を一覧表示します。

az deployment mg show

管理グループで展開を表示します。

az deployment mg validate

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

az deployment mg wait

デプロイ条件が満たされるまで CLI を待機状態にします。

az deployment mg what-if

管理グループのスコープで展開 What-If 操作を実行します。

az deployment mg cancel

管理グループで展開を取り消します。

az deployment mg cancel --management-group-id
                        --name
                        [--subscription]

管理グループで展開を取り消します。

az deployment mg cancel -m testmg -n deployment01

必須のパラメーター

--management-group-id -m

管理グループ id。

--name -n

デプロイ名。

省略可能のパラメーター

--subscription

サブスクリプションの名前または ID。 既定のサブスクリプションは、を使用して構成でき az account set -s NAME_OR_ID ます。

az deployment mg create

管理グループで展開を開始します。

az deployment mg create --location
                        --management-group-id
                        [--confirm-with-what-if]
                        [--handle-extended-json-format]
                        [--name]
                        [--no-prompt {false, true}]
                        [--no-wait]
                        [--parameters]
                        [--query-string]
                        [--subscription]
                        [--template-file]
                        [--template-spec]
                        [--template-uri]
                        [--what-if-exclude-change-types {Create, Delete, Deploy, Ignore, Modify, NoChange}]
                        [--what-if-result-format {FullResourcePayloads, ResourceIdOnly}]

ローカル JSON ファイルのパラメーターを使用して、リモートテンプレートファイルから管理グループで展開を作成します。

az deployment mg create --management-group-id testrg --name rollout01 --location WestUS \
    --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json

JSON 文字列のパラメーターを使用して、ローカルテンプレートファイルから管理グループで展開を作成します。

az deployment mg create --management-group-id testmg --name rollout01 --location WestUS \
    --template-file azuredeploy.json \
    --parameters '{ \"policyName\": { \"value\": \"policy2\" } }'

ローカルテンプレートから、パラメーターファイル、リモートパラメーターファイル、およびキーと値のペアを選択的にオーバーライドして、管理グループで展開を作成します。

az deployment mg create --management-group-id testmg --name rollout01 --location WestUS \
    --template-file azuredeploy.json --parameters @params.json \
    --parameters https://mysite/params.json --parameters MyValue=This MyArray=@array.json

必須のパラメーター

--location -l

配置メタデータを格納する場所。

--management-group-id -m

展開を作成する管理グループ id。

省略可能のパラメーター

--confirm-with-what-if -c

デプロイを実行する前に、展開 What-If を実行するようにコマンドに指示します。 次に、続行する前に、リソースの変更を確認するプロンプトが表示されます。

--handle-extended-json-format -j

展開の複数行とコメントを含む拡張テンプレートコンテンツの処理をサポートします。

--name -n

デプロイ名。

--no-prompt

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

承認された値: false, true
--no-wait

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

--parameters -p

配置パラメーターの値を指定します。

--query-string -q

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

--subscription

サブスクリプションの名前または ID。 既定のサブスクリプションは、を使用して構成でき az account set -s NAME_OR_ID ます。

--template-file -f

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

--template-spec -s

テンプレート仕様のリソース id。

--template-uri -u

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

--what-if-exclude-change-types -x

What-If の結果から除外するリソース変更の種類のスペース区切りの一覧。 --Confirm-with-what-if が設定されている場合に適用されます。

承認された値: Create, Delete, Deploy, Ignore, Modify, NoChange
--what-if-result-format -r

What-If の結果の形式。 が設定されている場合に適用 --confirm-with-what-if されます。

承認された値: FullResourcePayloads, ResourceIdOnly
既定値: FullResourcePayloads

az deployment mg delete

管理グループで展開を削除します。

az deployment mg delete --management-group-id
                        --name
                        [--no-wait]
                        [--subscription]

管理グループで展開を削除します。

az deployment mg delete -m testmg -n deployment01

必須のパラメーター

--management-group-id -m

管理グループ id。

--name -n

デプロイ名。

省略可能のパラメーター

--no-wait

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

--subscription

サブスクリプションの名前または ID。 既定のサブスクリプションは、を使用して構成でき az account set -s NAME_OR_ID ます。

az deployment mg export

デプロイに使用されたテンプレートをエクスポートします。

az deployment mg export --management-group-id
                        --name
                        [--subscription]

管理グループでの展開に使用されるテンプレートをエクスポートします。

az deployment mg export --management-group-id testmg --name MyDeployment

必須のパラメーター

--management-group-id -m

管理グループ id。

--name -n

デプロイ名。

省略可能のパラメーター

--subscription

サブスクリプションの名前または ID。 既定のサブスクリプションは、を使用して構成でき az account set -s NAME_OR_ID ます。

az deployment mg list

管理グループで展開を一覧表示します。

az deployment mg list --management-group-id
                      [--filter]
                      [--query-examples]
                      [--subscription]

管理グループで展開を一覧表示します。

az deployment mg list -m testmg

必須のパラメーター

--management-group-id -m

管理グループ id。

省略可能のパラメーター

--filter

OData 表記を使用して式をフィルター処理します。 --Filter "provisioningState eq ' {state} '" を使用して、provisioningState をフィルター処理できます。 詳細については、「」を参照してください https://docs.microsoft.com/en-us/rest/api/resources/deployments/listatsubscriptionscope#uri-parameters

--query-examples

Jのパス文字列をお勧めします。 クエリの1つをコピーして、--query パラメーターの後に二重引用符で囲んで、結果を確認することができます。 これらのキーワードに基づいて提案を行うことができるように、1つまたは複数の位置指定キーワードを追加することができます。

--subscription

サブスクリプションの名前または ID。 既定のサブスクリプションは、を使用して構成でき az account set -s NAME_OR_ID ます。

az deployment mg show

管理グループで展開を表示します。

az deployment mg show --management-group-id
                      --name
                      [--query-examples]
                      [--subscription]

管理グループで展開を表示します。

az deployment mg show -m testmg -n deployment01

必須のパラメーター

--management-group-id -m

管理グループ id。

--name -n

デプロイ名。

省略可能のパラメーター

--query-examples

Jのパス文字列をお勧めします。 クエリの1つをコピーして、--query パラメーターの後に二重引用符で囲んで、結果を確認することができます。 これらのキーワードに基づいて提案を行うことができるように、1つまたは複数の位置指定キーワードを追加することができます。

--subscription

サブスクリプションの名前または ID。 既定のサブスクリプションは、を使用して構成でき az account set -s NAME_OR_ID ます。

az deployment mg validate

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

az deployment mg validate --location
                          --management-group-id
                          [--handle-extended-json-format]
                          [--name]
                          [--no-prompt {false, true}]
                          [--parameters]
                          [--query-string]
                          [--subscription]
                          [--template-file]
                          [--template-spec]
                          [--template-uri]

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

az deployment mg validate --management-group-id testmg --location WestUS --template-file {template-file}

テンプレートが管理グループで有効かどうかを検証します。 自動

az deployment mg validate --location WestUS --management-group-id testmg --name mydeployment --parameters @myparameters.json --template-file azuredeploy.json

必須のパラメーター

--location -l

配置メタデータを格納する場所。

--management-group-id -m

展開を作成する管理グループ id。

省略可能のパラメーター

--handle-extended-json-format -j

展開の複数行とコメントを含む拡張テンプレートコンテンツの処理をサポートします。

--name -n

デプロイ名。

--no-prompt

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

承認された値: false, true
--parameters -p

配置パラメーターの値を指定します。

--query-string -q

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

--subscription

サブスクリプションの名前または ID。 既定のサブスクリプションは、を使用して構成でき az account set -s NAME_OR_ID ます。

--template-file -f

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

--template-spec -s

テンプレート仕様のリソース id。

--template-uri -u

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

az deployment mg wait

デプロイ条件が満たされるまで CLI を待機状態にします。

az deployment mg wait --management-group-id
                      --name
                      [--created]
                      [--custom]
                      [--deleted]
                      [--exists]
                      [--interval]
                      [--subscription]
                      [--timeout]
                      [--updated]

必須のパラメーター

--management-group-id -m

管理グループ id。

--name -n

デプロイ名。

省略可能のパラメーター

--created

' ProvisioningState ' が ' Succeeded ' で作成されるまで待機します。

--custom

条件がカスタム Jのパスクエリを満たすまで待機します。 例: provisioningState! = ' InProgress ', instanceView. 状態 [? code = = ' PowerState/running ']。

--deleted

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

--exists

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

--interval

ポーリング間隔 (秒)。

既定値: 30
--subscription

サブスクリプションの名前または ID。 既定のサブスクリプションは、を使用して構成でき az account set -s NAME_OR_ID ます。

--timeout

最大待機時間 (秒)。

既定値: 3600
--updated

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

az deployment mg what-if

管理グループのスコープで展開 What-If 操作を実行します。

az deployment mg what-if --location
                         --management-group-id
                         [--exclude-change-types {Create, Delete, Deploy, Ignore, Modify, NoChange}]
                         [--name]
                         [--no-pretty-print]
                         [--no-prompt {false, true}]
                         [--parameters]
                         [--query-string]
                         [--result-format {FullResourcePayloads, ResourceIdOnly}]
                         [--subscription]
                         [--template-file]
                         [--template-spec]
                         [--template-uri]

管理グループで展開 What-If 操作を実行します。

az deployment mg what-if --management-group-id testmg --location westus --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json

ResourceIdOnly 形式の管理グループで展開 What-If 操作を実行します。

az deployment mg what-if --management-group-id testmg --location westus --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --result-format ResourceIdOnly

結果をきれいに印刷せずに、管理グループで展開 What-If 操作を実行します。

az deployment mg what-if --management-group-id testmg --location westus --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --no-pretty-print

必須のパラメーター

--location -l

配置メタデータを格納する場所。

--management-group-id -m

展開を作成する管理グループ id。

省略可能のパラメーター

--exclude-change-types -x

What-If の結果から除外するリソース変更の種類のスペース区切りの一覧。

承認された値: Create, Delete, Deploy, Ignore, Modify, NoChange
--name -n

デプロイ名。

--no-pretty-print

What-If の結果に対しては、非常に印刷を無効にします。 設定すると、出力形式の種類が使用されます。

--no-prompt

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

承認された値: false, true
--parameters -p

配置パラメーターの値を指定します。

--query-string -q

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

--result-format -r

What-If の結果の形式。

承認された値: FullResourcePayloads, ResourceIdOnly
既定値: FullResourcePayloads
--subscription

サブスクリプションの名前または ID。 既定のサブスクリプションは、を使用して構成でき az account set -s NAME_OR_ID ます。

--template-file -f

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

--template-spec -s

テンプレート仕様のリソース id。

--template-uri -u

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