Start-AzPolicyRemediation
ポリシー割り当てのポリシー修復を作成して開始します。
構文
Start-AzPolicyRemediation
-Name <String>
[-Scope <String>]
[-ManagementGroupName <String>]
[-ResourceGroupName <String>]
-PolicyAssignmentId <String>
[-PolicyDefinitionReferenceId <String>]
[-LocationFilter <String[]>]
[-ResourceDiscoveryMode <String>]
[-ResourceCount <Int32>]
[-ParallelDeploymentCount <Int32>]
[-FailureThreshold <Double>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Start-AzPolicyRemediation
-ResourceId <String>
-PolicyAssignmentId <String>
[-PolicyDefinitionReferenceId <String>]
[-LocationFilter <String[]>]
[-ResourceDiscoveryMode <String>]
[-ResourceCount <Int32>]
[-ParallelDeploymentCount <Int32>]
[-FailureThreshold <Double>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Start-AzPolicyRemediation コマンドレットは、特定のポリシー割り当てのポリシー修復を作成します。 修復のスコープ以下のすべての非準拠リソースが修復されます。 修復は、'deployIfNotExists' 効果を持つポリシーでのみサポートされます。
例
例 1: サブスクリプション スコープで修復を開始する
$policyAssignmentId = "/subscriptions/f0710c27-9663-4c05-19f8-1b4be01e86a5/providers/Microsoft.Authorization/policyAssignments/2deae24764b447c29af7c309"
Set-AzContext -Subscription "My Subscription"
Start-AzPolicyRemediation -PolicyAssignmentId $policyAssignmentId -Name "remediation1"
このコマンドは、指定されたポリシー割り当てのサブスクリプション 'My Subscription' に新しいポリシー修復を作成します。
例 2: オプションのフィルターを使用して管理グループ スコープで修復を開始する
$policyAssignmentId = "/providers/Microsoft.Management/managementGroups/mg1/providers/Microsoft.Authorization/policyAssignments/pa1"
Start-AzPolicyRemediation -ManagementGroupName "mg1" -PolicyAssignmentId $policyAssignmentId -Name "remediation1" -LocationFilter "westus","eastus"
このコマンドは、指定されたポリシー割り当ての管理グループ 'mg1' に新しいポリシー修復を作成します。 "westus" または "eastus" の場所にあるリソースのみが修復されます。
例 3: ポリシー セット定義の割り当てのリソース グループ スコープで修復を開始する
$policyAssignmentId = "/subscriptions/f0710c27-9663-4c05-19f8-1b4be01e86a5/resourceGroups/myRG/providers/Microsoft.Authorization/policyAssignments/2deae24764b447c29af7c309"
Start-AzPolicyRemediation -ResourceGroupName "myRG" -PolicyAssignmentId $policyAssignmentId -PolicyDefinitionReferenceId "0349234412441" -Name "remediation1"
このコマンドは、指定されたポリシー割り当てのリソース グループ 'myRG' に新しいポリシー修復を作成します。 ポリシー割り当てによって、ポリシー セット定義 (イニシアチブとも呼ばれます) が割り当てられます。 ポリシー定義参照 ID は、イニシアチブ内のどのポリシーを修復する必要があることを示します。
例 4: 修復を開始し、バックグラウンドで完了するまで待機する
$policyAssignmentId = "/subscriptions/f0710c27-9663-4c05-19f8-1b4be01e86a5/providers/Microsoft.Authorization/policyAssignments/2deae24764b447c29af7c309"
Set-AzContext -Subscription f0710c27-9663-4c05-19f8-1b4be01e86a5
$job = Start-AzPolicyRemediation -PolicyAssignmentId $policyAssignmentId -Name "remediation1" -AsJob
$job | Wait-Job
$remediation = $job | Receive-Job
このコマンドは、指定されたポリシー割り当てについて、サブスクリプション 'My Subscription' で新しいポリシー修復を開始します。 修復が完了するまで待ってから、最終的な修復状態が返されます。
例 5: 修復前に準拠していないリソースを検出する修復を開始する
$policyAssignmentId = "/subscriptions/f0710c27-9663-4c05-19f8-1b4be01e86a5/providers/Microsoft.Authorization/policyAssignments/2deae24764b447c29af7c309"
Set-AzContext -Subscription "My Subscription"
Start-AzPolicyRemediation -PolicyAssignmentId $policyAssignmentId -Name "remediation1" -ResourceDiscoveryMode ReEvaluateCompliance
このコマンドは、指定されたポリシー割り当てのサブスクリプション 'My Subscription' に新しいポリシー修復を作成します。 サブスクリプション内のリソースのコンプライアンス状態がポリシーの割り当てに対して再評価され、準拠していないリソースが修復されます。
例 6: 最大 10,000 個の非準拠リソースを修復する修復を開始する
$policyAssignmentId = "/subscriptions/f0710c27-9663-4c05-19f8-1b4be01e86a5/providers/Microsoft.Authorization/policyAssignments/2deae24764b447c29af7c309"
Set-AzContext -Subscription "My Subscription"
Start-AzPolicyRemediation -PolicyAssignmentId $policyAssignmentId -Name "remediation1" -ResourceCount 10000
例 7: 30 個のリソースを並列で修復する修復を開始する
$policyAssignmentId = "/subscriptions/f0710c27-9663-4c05-19f8-1b4be01e86a5/providers/Microsoft.Authorization/policyAssignments/2deae24764b447c29af7c309"
Set-AzContext -Subscription "My Subscription"
Start-AzPolicyRemediation -PolicyAssignmentId $policyAssignmentId -Name "remediation1" -ParallelDeploymentCount 30
例 8: 修復デプロイの半分以上が失敗した場合に終了する修復を開始する
$policyAssignmentId = "/subscriptions/f0710c27-9663-4c05-19f8-1b4be01e86a5/providers/Microsoft.Authorization/policyAssignments/2deae24764b447c29af7c309"
Set-AzContext -Subscription "My Subscription"
Start-AzPolicyRemediation -PolicyAssignmentId $policyAssignmentId -Name "remediation1" -FailureThreshold 0.5
パラメーター
-AsJob
バックグラウンドでコマンドレットを実行します。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
型: | SwitchParameter |
Aliases: | cf |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。
型: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-FailureThreshold
エラーしきい値の割合を表す 0.0 から 1.0 までの数値。 修復操作の失敗 (デプロイの失敗) の割合がこのしきい値を超えると、修復は失敗します。
型: | Nullable<T>[Double] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-LocationFilter
修復に含める必要があるリソースの場所。 これらの場所に存在しないリソースは修復されません。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ManagementGroupName
管理グループ ID。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Name
リソース名。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ParallelDeploymentCount
特定の時点で修復するリソースの数。 修復のペースを制御するために使用できます。 指定しない場合は、既定の並列デプロイ値が使用されます。
型: | Nullable<T>[Int32] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-PolicyAssignmentId
ポリシー割り当て ID。 例: '/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyAssignments/{assignmentName}'。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-PolicyDefinitionReferenceId
修復される個々の定義のポリシー定義参照 ID を取得します。 ポリシー割り当てがポリシー セット定義を割り当てるときに必要です。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ResourceCount
修復される非準拠リソースの最大数。 指定しない場合は、既定のリソース数が使用されます。
型: | Nullable<T>[Int32] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ResourceDiscoveryMode
修復タスクで、修復が必要なリソースを検出する方法について説明します。 管理グループスコープを修復する場合、ReEvaluateCompliance はサポートされません。
型: | String |
指定可能な値: | ExistingNonCompliant, ReEvaluateCompliance |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ResourceGroupName
リソース グループ名。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ResourceId
リソースの ID
型: | String |
Aliases: | Id |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Scope
リソースのスコープ。 例: '/subscriptions/{subscriptionId}/resourceGroups/{rgName}'。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
String[]
Nullable<T>[[System.Int32, System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
Nullable<T>[[System.Double, System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]