Set-AzPolicyExemption
ポリシーの除外を変更します。
構文
Set-AzPolicyExemption
-Name <String>
[-Scope <String>]
[-DisplayName <String>]
[-Description <String>]
[-ExemptionCategory <String>]
[-PolicyDefinitionReferenceId <String[]>]
[-ExpiresOn <DateTime>]
[-ClearExpiration]
[-Metadata <String>]
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzPolicyExemption
-Id <String>
[-DisplayName <String>]
[-Description <String>]
[-ExemptionCategory <String>]
[-PolicyDefinitionReferenceId <String[]>]
[-ExpiresOn <DateTime>]
[-ClearExpiration]
[-Metadata <String>]
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzPolicyExemption
[-DisplayName <String>]
[-Description <String>]
[-ExemptionCategory <String>]
[-PolicyDefinitionReferenceId <String[]>]
[-ExpiresOn <DateTime>]
[-ClearExpiration]
[-Metadata <String>]
-InputObject <PsPolicyExemption>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Set-AzPolicyExemption コマンドレットは、ポリシーの除外を変更します。 ID または名前とスコープで除外を指定します。
例
例 1: 表示名を更新する
$ResourceGroup = Get-AzResourceGroup -Name 'ResourceGroup11'
$PolicyExemption = Get-AzPolicyExemption -Name 'PolicyExemption07' -Scope $ResourceGroup.ResourceId
Set-AzPolicyExemption -Id $PolicyExemption.ResourceId -DisplayName 'Exempt VM creation limit'
最初のコマンドは、Get-AzResourceGroup コマンドレットを使用して ResourceGroup11 という名前のリソース グループを取得します。 このコマンドは、そのオブジェクトを $ResourceGroup 変数に格納します。 2 番目のコマンドは、Get-AzPolicyExemption コマンドレットを使用して PolicyExemption07 という名前のポリシー除外を取得します。 このコマンドは、そのオブジェクトを $PolicyExemption 変数に格納します。 最後のコマンドは、$ResourceGroupの ResourceId プロパティによって識別されるリソース グループのポリシー除外の表示名を更新します。
例 2: 有効期限の日時を更新する
$NextMonth = (Get-Date).AddMonths(1)
$PolicyExemption = Get-AzPolicyExemption -Name 'PolicyExemption07'
Set-AzPolicyExemption -Id $PolicyExemption.ResourceId -ExpiresOn $NextMonth
最初のコマンドは、Get-Date コマンドレットを使用して現在の日付時刻を取得し、現在の日付時刻に 1 か月を追加します。コマンドはそのオブジェクトを $NextMonth 変数に格納します。 2 番目のコマンドは、Get-AzPolicyExemption コマンドレットを使用して PolicyExemption07 という名前のポリシー除外を取得します。 このコマンドは、そのオブジェクトを $PolicyExemption 変数に格納します。 最後のコマンドは、既定のサブスクリプションのポリシー除外の有効期限を更新します。
例 3: 有効期限の日時をクリアする
$PolicyExemption = Get-AzPolicyExemption -Name 'PolicyExemption07'
Set-AzPolicyExemption -Id $PolicyExemption.ResourceId -ClearExpiration
最初のコマンドは、Get-AzPolicyExemption コマンドレットを使用して PolicyExemption07 という名前のポリシー除外を取得します。 このコマンドは、そのオブジェクトを $PolicyExemption 変数に格納します。 2 番目のコマンドは、既定のサブスクリプションのポリシー除外の有効期限をクリアします。 更新された除外は期限切れになりません。
例 4: 有効期限カテゴリを更新する
$PolicyExemption = Get-AzPolicyExemption -Name 'PolicyExemption07'
Set-AzPolicyExemption -Id $PolicyExemption.ResourceId -ExemptionCategory Mitigated
最初のコマンドは、Get-AzPolicyExemption コマンドレットを使用して PolicyExemption07 という名前のポリシー除外を取得します。 このコマンドは、そのオブジェクトを $PolicyExemption 変数に格納します。 2 番目のコマンドは、既定のサブスクリプションのポリシー除外の有効期限カテゴリを更新します。 更新された除外は期限切れになりません。
パラメーター
-ApiVersion
設定すると、使用するリソース プロバイダー API のバージョンを示します。 指定しない場合、API のバージョンは、使用可能な最新のバージョンとして自動的に決定されます。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ClearExpiration
設定した場合、このスイッチは更新されたポリシー除外の有効期限の日付と時刻をクリアします。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
型: | SwitchParameter |
Aliases: | cf |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。
型: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Description
更新されたポリシー除外の説明。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-DisplayName
更新されたポリシー除外の表示名。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ExemptionCategory
更新されたポリシー除外のポリシー除外カテゴリ。 使用可能な値は、免除と軽減です。
型: | String |
指定可能な値: | Waiver, Mitigated |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ExpiresOn
更新されたポリシー除外の有効期限の日付と時刻 (UTC ISO 8601 形式の yyyy-MM-ddTHH:mm:ssZ)。
型: | Nullable<T>[DateTime] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Id
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Authorization/policyExemptions/{policyExemptionName} などのスコープを含む、更新する完全修飾ポリシー除外 ID。
型: | String |
Aliases: | ResourceId |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-InputObject
別のコマンドレットから出力された更新するポリシー除外オブジェクト。
型: | PsPolicyExemption |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Metadata
更新されたポリシー除外のメタデータ。 これには、メタデータ JSON を含むファイルへのパス、または JSON 文字列としてのメタデータを指定できます。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Name
更新するポリシー除外の名前。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-PolicyDefinitionReferenceId
関連付けられたポリシー割り当てがポリシー セット (イニシアティブ) に対する場合のポリシー定義参照 ID リスト。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Pre
設定すると、使用するバージョンを自動的に決定するときに、コマンドレットでプレリリース API バージョンを使用する必要があることを示します。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Scope
更新されたポリシー除外のスコープ (/providers/managementGroups/{managementGroupName} など) は、既定で現在のサブスクリプションに設定されます。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
String[]
Nullable<T>[[System.DateTime, System.Private.CoreLib, Version=5.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]