az stack-whatif group

デプロイ スタックの What-If の結果をリソース グループ スコープで管理します。

コマンド

Name 説明 型 状態
az stack-whatif group create

デプロイ スタックの what-if の結果をリソース グループ スコープで作成します。

 Core GA
az stack-whatif group delete

デプロイ スタックの what-if の結果をリソース グループ スコープから削除します。

 Core GA
az stack-whatif group list

すべてのデプロイ スタックの what-if 結果をリソース グループに一覧表示します。

 Core GA
az stack-whatif group show

リソース グループ スコープからデプロイ スタックの what-if の結果を取得します。

 Core GA

az stack-whatif group create

デプロイ スタックの what-if の結果をリソース グループ スコープで作成します。

az stack-whatif group create --action-on-unmanage --aou {deleteAll, deleteResources, detachAll}
                             --deny-settings-mode --dm {denyDelete, denyWriteAndDelete, none}
                             --name
                             --resource-group
                             --retention-interval --ri
                             --stack-id
                             [--acquire-policy-token]
                             [--change-reference]
                             [--cs --deny-settings-apply-to-child-scopes]
                             [--deny-settings-excluded-actions --ea]
                             [--deny-settings-excluded-principals --ep]
                             [--description]
                             [--no-color]
                             [--no-pretty-print]
                             [--no-wait]
                             [--parameters]
                             [--query-string]
                             [--resources-without-delete-support --rwd {detach, fail}]
                             [--tags]
                             [--template-file]
                             [--template-spec]
                             [--template-uri]
                             [--validation-level --vl {Provider, ProviderNoRbac, Template}]

例

テンプレート ファイルを使用してデプロイ スタックで what-if を実行し、アンマネージドのリソースを削除します。

az stack-whatif group create --name ResultName --resource-group ResourceGroup --action-on-unmanage deleteResources --template-file simpleTemplate.json --description description --deny-settings-mode None --ri P5D --stack-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup/providers/Microsoft.Resources/deploymentStacks/mySubStack

パラメーター ファイルを使用してデプロイ スタックで what-if を実行し、アンマネージド上のすべてのリソースをデタッチし、出力から色を削除します。

az stack-whatif group create --name ResultName --resource-group ResourceGroup --no-color --action-on-unmanage detachAll --template-file simpleTemplate.json --parameters simpleTemplateParams.json --description description --deny-settings-mode None --ri P5D --stack-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup/providers/Microsoft.Resources/deploymentStacks/mySubStack

テンプレート スペックを使用してデプロイ スタックで what-if を実行し、アンマネージドのすべてのリソースを削除します。

az stack-whatif group create --name ResultName --resource-group ResourceGroup --action-on-unmanage deleteAll --template-spec TemplateSpecResourceIDWithVersion --description description --deny-settings-mode None --ri P5D --stack-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup/providers/Microsoft.Resources/deploymentStacks/mySubStack

bicep ファイルを使用して、デプロイ スタックで what-if を実行します。

az stack-whatif group create --name ResultName --resource-group ResourceGroup --template-file simple.bicep --description description --deny-settings-mode None --action-on-unmanage deleteResources --ri P5D --stack-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup/providers/Microsoft.Resources/deploymentStacks/mySubStack

別のサブスクリプションのデプロイ スタックで What-If を実行します。

az stack-whatif group create --name ResultName --resource-group ResourceGroup --template-file simpleTemplate.json --description description --subscription subscriptionId --deny-settings-mode None --action-on-unmanage deleteResources --ri P5D --stack-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup/providers/Microsoft.Resources/deploymentStacks/mySubStack

キーと値のペアのパラメーターを使用して、デプロイ スタックで what-if を実行します。

az stack-whatif group create --name ResultName --template-file simpleTemplate.json --resource-group ResourceGroup --description description --parameters simpleTemplateParams.json value1=foo value2=bar --deny-settings-mode None --action-on-unmanage deleteResources --ri P5D --stack-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup/providers/Microsoft.Resources/deploymentStacks/mySubStack

パラメーター ファイル、リモート パラメーター ファイル、およびキーと値のペアを選択的にオーバーライドして、ローカル テンプレートからデプロイ スタックで what-if を実行します。

az stack-whatif group create --name ResultName --template-file azuredeploy.json --parameters @params.json --parameters https://mysite/params.json --parameters MyValue=This MyArray=@array.json --resource-group ResourceGroup --deny-settings-mode None --action-on-unmanage deleteResources --ri P5D --stack-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup/providers/Microsoft.Resources/deploymentStacks/mySubStack

拒否設定を使用して、ローカル テンプレートからデプロイ スタックで What-If を実行します。

az stack-whatif group create --name ResultName --resource-group ResourceGroup --template-file azuredeploy.json --deny-settings-mode denyDelete --deny-settings-excluded-actions Microsoft.Compute/virtualMachines/write --deny-settings-excluded-principals "test1 test2" --action-on-unmanage deleteResources --ri P5D --stack-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup/providers/Microsoft.Resources/deploymentStacks/mySubStack

ローカル テンプレートからデプロイ スタックで What-If を実行し、子スコープに拒否設定を適用します。

az stack-whatif group create --name ResultName --resource-group ResourceGroup --template-file azuredeploy.json --deny-settings-mode denyDelete --deny-settings-excluded-actions Microsoft.Compute/virtualMachines/write --deny-settings-apply-to-child-scopes --action-on-unmanage deleteResources --ri P5D --stack-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup/providers/Microsoft.Resources/deploymentStacks/mySubStack

必須パラメーター

--action-on-unmanage --aou

スタックの更新または削除後に管理されなくなったリソースに対する動作を定義します。

プロパティ 値
指定可能な値: deleteAll, deleteResources, detachAll
--deny-settings-mode --dm

スタックによって管理されるリソースに対して拒否される操作を定義します。

プロパティ 値
指定可能な値: denyDelete, denyWriteAndDelete, none
--name -n

デプロイ スタックの what-if 結果の名前。

--resource-group -g

デプロイ スタックの what-if 結果が作成されるリソース グループ。

--retention-interval --ri

What-If 結果の保持間隔。 値は ISO 8601 形式で、1 日から 30 日の間である必要があります。

--stack-id

What-If 操作を実行するデプロイ スタックの完全修飾 ID。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--cs --deny-settings-apply-to-child-scopes

DenySettings は子スコープに適用されます。

プロパティ 値
規定値: False
--deny-settings-excluded-actions --ea

denySettings から除外されるロールベースの管理操作の一覧。 最大 200 個のアクションが許可されます。

--deny-settings-excluded-principals --ep

ロックから除外された AAD プリンシパル ID の一覧。 最大 5 つのプリンシパルが許可されます。

--description

デプロイ スタックの説明。

--no-color

綺麗に印刷された what-if の結果で色を無効にします。

--no-pretty-print

What-If 結果のプリプリントを無効にします。 設定すると、出力形式の種類が使用されます。

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ 値
規定値: False
--parameters -p

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

--query-string -q

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

--resources-without-delete-support --rwd

削除をサポートしていないリソースがスタックによって管理されなくなった場合の動作を定義します。

プロパティ 値
指定可能な値: detach, fail
--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--template-file -f

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

--template-spec -s

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

--template-uri -u

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

--validation-level --vl

デプロイ スタックの検証レベル。 既定値は "Provider" です。

プロパティ 値
指定可能な値: Provider, ProviderNoRbac, Template
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az stack-whatif group delete

デプロイ スタックの what-if の結果をリソース グループ スコープから削除します。

az stack-whatif group delete [--acquire-policy-token]
                             [--change-reference]
                             [--id]
                             [--name]
                             [--resource-group]
                             [--yes]

例

名前でスタック what-if の結果を削除します。

az stack-whatif group delete --name ResultName --resource-group ResourceGroup

リソース ID でスタック what-if の結果を削除します。

az stack-whatif group delete --id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup/providers/Microsoft.Resources/deploymentStacksWhatIfResults/ResultName

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--id

デプロイ スタックの what-if 結果リソース ID。

--name -n

デプロイ スタックの what-if 結果の名前。

--resource-group -g

デプロイ スタックの what-if 結果が存在するリソース グループ。

--yes

確認のダイアログを表示しません。

プロパティ 値
規定値: False
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az stack-whatif group list

すべてのデプロイ スタックの what-if 結果をリソース グループに一覧表示します。

az stack-whatif group list --resource-group

例

すべてのスタックの what-if 結果をリソース グループに一覧表示します。

az stack-whatif group list --resource-group ResourceGroup

必須パラメーター

--resource-group -g

デプロイ スタックの what-if 結果が存在するリソース グループ。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az stack-whatif group show

リソース グループ スコープからデプロイ スタックの what-if の結果を取得します。

az stack-whatif group show [--id]
                           [--name]
                           [--no-color]
                           [--no-pretty-print]
                           [--resource-group]
                           [--with-property-changes --wpc {false, true}]

例

名前でスタック what-if の結果を取得します。

az stack-whatif group show --name ResultName --resource-group ResourceGroup

色のない名前でスタック what-if の結果を取得します。

az stack-whatif group show --name ResultName --resource-group ResourceGroup --no-color

名前でスタック what-if 結果の JSON を取得します。

az stack-whatif group show --name ResultName --resource-group ResourceGroup --no-pretty-print

リソース ID でスタック what-if の結果を取得します。

az stack-whatif group show --id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup/providers/Microsoft.Resources/deploymentStacksWhatIfResults/ResultName

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--id

デプロイ スタックの what-if 結果リソース ID。

--name -n

デプロイ スタックの what-if 結果の名前。

--no-color

綺麗に印刷された what-if の結果で色を無効にします。

--no-pretty-print

What-If 結果のプリプリントを無効にします。 設定すると、出力形式の種類が使用されます。

--resource-group -g

デプロイ スタックの what-if 結果が存在するリソース グループ。

--with-property-changes --wpc

リソース プロパティの変更を含む What-If 結果を返すフラグ。

プロパティ 値
指定可能な値: false, true
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False