Update-AzPolicyExemption

リファレンス

モジュール:: Az.Resources

この操作により、指定されたスコープと名前でポリシーの除外が更新されます。

構文

Update-AzPolicyExemption
      -Name <String>
      [-Scope <String>]
      [-ExemptionCategory <String>]
      [-PolicyDefinitionReferenceId <String[]>]
      [-DisplayName <String>]
      [-Description <String>]
      [-ExpiresOn <DateTime>]
      [-ClearExpiration]
      [-Metadata <String>]
      [-BackwardCompatible]
      [-AssignmentScopeValidation <String>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicyExemption
      [-ExemptionCategory <String>]
      [-PolicyDefinitionReferenceId <String[]>]
      -Id <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-ExpiresOn <DateTime>]
      [-ClearExpiration]
      [-Metadata <String>]
      [-BackwardCompatible]
      [-AssignmentScopeValidation <String>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicyExemption
      [-ExemptionCategory <String>]
      [-PolicyDefinitionReferenceId <String[]>]
      [-DisplayName <String>]
      [-Description <String>]
      [-ExpiresOn <DateTime>]
      [-ClearExpiration]
      [-Metadata <String>]
      [-BackwardCompatible]
      [-AssignmentScopeValidation <String>]
      -InputObject <IPolicyExemption>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

この操作により、指定されたスコープと名前でポリシーの除外が更新されます。

例

例 1: 表示名を更新する

$ResourceGroup = Get-AzResourceGroup -Name 'ResourceGroup11'
 $PolicyExemption = Get-AzPolicyExemption -Name 'PolicyExemption07' -Scope $ResourceGroup.ResourceId
Update-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'
Update-AzPolicyExemption -Id $PolicyExemption.ResourceId -ExpiresOn $NextMonth

最初のコマンドは、Get-Date コマンドレットを使用して現在の日付時刻を取得し、現在の日付時刻に 1 か月を追加します。コマンドはそのオブジェクトを $NextMonth 変数に格納します。 2 番目のコマンドは、Get-AzPolicyExemption コマンドレットを使用して PolicyExemption07 という名前のポリシー除外を取得します。このコマンドは、そのオブジェクトを $PolicyExemption 変数に格納します。最後のコマンドは、既定のサブスクリプションのポリシー除外の有効期限を更新します。

例 3: 有効期限の日時をクリアする

$PolicyExemption = Get-AzPolicyExemption -Name 'PolicyExemption07'
Update-AzPolicyExemption -Id $PolicyExemption.ResourceId -ClearExpiration

最初のコマンドは、Get-AzPolicyExemption コマンドレットを使用して PolicyExemption07 という名前のポリシー除外を取得します。このコマンドは、そのオブジェクトを $PolicyExemption 変数に格納します。 2 番目のコマンドは、既定のサブスクリプションのポリシー除外の有効期限をクリアします。更新された除外は期限切れになりません。

例 4: 有効期限カテゴリを更新する

$PolicyExemption = Get-AzPolicyExemption -Name 'PolicyExemption07'
Update-AzPolicyExemption -Id $PolicyExemption.ResourceId -ExemptionCategory Mitigated

最初のコマンドは、Get-AzPolicyExemption コマンドレットを使用して PolicyExemption07 という名前のポリシー除外を取得します。このコマンドは、そのオブジェクトを $PolicyExemption 変数に格納します。 2 番目のコマンドは、既定のサブスクリプションのポリシー除外の有効期限カテゴリを更新します。更新された除外は期限切れになりません。

例 5: [Backcompat] 有効期限の日時をクリアする

$PolicyExemption = Get-AzPolicyExemption -Name 'PolicyExemption07'
Set-AzPolicyExemption -Id $PolicyExemption.ResourceId -ClearExpiration

パラメーター

-AssignmentScopeValidation

除外が割り当てスコープにあるか、または割り当てスコープの下にあるかを検証するオプション。

型:	String
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BackwardCompatible

プロパティバッグオブジェクトにポリシー固有のプロパティを配置する従来の形式を使用して、コマンドレットから成果物が返されます。

型:	SwitchParameter
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ClearExpiration

ポリシー除外の有効期限の日付と時刻をクリアするかどうかを示します。

型:	SwitchParameter
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

型:	SwitchParameter
Aliases:	cf
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

DefaultProfile パラメーターは機能しません。別のサブスクリプションに対してコマンドレットを実行する場合は、使用可能な場合は SubscriptionId パラメーターを使用します。

型:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

このメッセージは、ポリシー違反が発生した場合の応答の一部になります。

型:	String
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-DisplayName

ポリシー割り当ての表示名。

型:	String
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ExemptionCategory

ポリシー除外カテゴリ

型:	String
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ExpiresOn

ポリシー除外の有効期限の日付と時刻 (UTC ISO 8601 形式 yyyy-MM-ddTHH:mm:ssZ)。

型:	Nullable<T>[DateTime]
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Id

削除するポリシー割り当ての ID。 '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}' の形式を使用します。

型:	String
Aliases:	ResourceId
Position:	Named
既定値:	None
必須:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-InputObject

型:	IPolicyExemption
Position:	Named
既定値:	None
必須:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Metadata

ポリシー割り当てのメタデータ。メタデータはオープンエンドオブジェクトであり、通常はキーと値のペアのコレクションです。

型:	String
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

ポリシー除外の名前。

型:	String
Aliases:	PolicyExemptionName
Position:	Named
既定値:	None
必須:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-PolicyDefinitionReferenceId

関連付けられたポリシー割り当てがポリシーセット (イニシアティブ) に対する場合のポリシー定義参照 ID リスト。

型:	String[]
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Scope

ポリシー除外のスコープ。有効なスコープは、管理グループ (形式: '/providers/Microsoft.Management/managementGroups/{managementGroup}')、サブスクリプション (形式: '/subscriptions/{subscriptionId}')、リソースグループ (形式: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}') です。またはリソース (形式: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'

型:	String
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-WhatIf

コマンドレットの実行時に発生する内容を示します。このコマンドレットは実行されません。

型:	SwitchParameter
Aliases:	wi
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

入力

IPolicyExemption

SwitchParameter

Nullable<T>[[System.DateTime, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

String

String[]

出力