Remove-AzPolicyEnrollment
構文
DeleteByNameAndScope (既定)
Remove-AzPolicyEnrollment
-Name <String>
-Scope <String>
[-Force]
[-DefaultProfile <PSObject>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
DeleteById
Remove-AzPolicyEnrollment
-Id <String>
[-Force]
[-DefaultProfile <PSObject>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-AzPolicyEnrollment
-InputObject <IPolicyEnrollment>
[-Force]
[-DefaultProfile <PSObject>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Remove-AzPolicyEnrollment コマンドレットは、名前と作成されたスコープを指定して、ポリシー登録を削除します。
ポリシー登録の範囲は、そのIDの中で「/providers/Microsoft.Authorization/policyEnrollments/{policyEnrollmentName}' の前に位置する部分です。
例
例 1: 名前とスコープによるポリシー登録の削除
$ResourceGroup = Get-AzResourceGroup -Name 'ResourceGroup11'
Remove-AzPolicyEnrollment -Name 'PolicyEnrollment07' -Scope $ResourceGroup.ResourceId -Confirm
最初のコマンドは、Get-AzResourceGroup コマンドレットを使用して ResourceGroup11 という名前のリソース グループを取得します。
このコマンドは、そのオブジェクトを $ResourceGroup 変数に格納します。
2 番目のコマンドは、リソース グループ スコープで PolicyEnrollment07 という名前のポリシー登録を削除します。
$ResourceGroupの ResourceId プロパティは、リソース グループを識別します。
例 2: ID によるポリシー登録の削除
$ResourceGroup = Get-AzResourceGroup -Name 'ResourceGroup11'
$PolicyEnrollment = Get-AzPolicyEnrollment -Name 'PolicyEnrollment07' -Scope $ResourceGroup.ResourceId
Remove-AzPolicyEnrollment -Id $PolicyEnrollment.Id -Force
最初のコマンドは ResourceGroup11 という名前のリソース グループを取得し、そのオブジェクトを $ResourceGroup 変数に格納します。
2 番目のコマンドは、リソース グループ レベルでポリシー登録を取得し、$PolicyEnrollment変数に格納します。
$ResourceGroupの ResourceId プロパティは、リソース グループを識別します。
最後のコマンドは、Force パラメーターを使用して確認プロンプトをバイパスして、$PolicyEnrollmentの Id プロパティが識別するポリシー登録を削除します。
パラメーター
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DefaultProfile
DefaultProfile パラメーターは機能しません。
別のサブスクリプションに対してコマンドレットを実行する場合は、使用可能な場合は SubscriptionId パラメーターを使用します。
パラメーターのプロパティ
| 型: | PSObject
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| エイリアス: | AzureRMContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Force
$true場合は、確認プロンプトをスキップします
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Id
削除するポリシー登録の ID。
'{scope}/providers/Microsoft の形式を使用します。Authorization/policyEnrollments/{policyEnrollmentName}'。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| エイリアス: | PolicyEnrollmentId, リソースID |
パラメーター セット
DeleteById
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
削除するポリシー登録オブジェクト。
DeleteByInputObject
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Name
保険加入名。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| エイリアス: | PolicyEnrollmentName |
パラメーター セット
DeleteByNameAndScope
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-PassThru
コマンドが成功したときに true を返します。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Scope
ポリシー登録のスコープ。
有効なスコープは、管理グループ (形式: '/providers/Microsoft) です。Management/managementGroups/{managementGroup}')、サブスクリプション (形式: '/subscriptions/{subscriptionId}')、リソース グループ (形式: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}')、またはリソース (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}')
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
DeleteByNameAndScope
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。
コマンドレットは実行されません。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットは、共通パラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable をサポートします。 詳細については、about_CommonParametersを参照してください。
出力