Set-AzPolicyExemption

  • 參考
模組:
Az.Resources

修改原則豁免。

Syntax

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>]

Description

Set-AzPolicyExemption Cmdlet 會修改原則豁免。 依標識碼或名稱和範圍指定豁免。

範例

範例 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 Cmdlet 取得名為 ResourceGroup11 的資源群組。 命令會將該物件儲存在 $ResourceGroup 變數中。 第二個命令會使用 Get-AzPolicyExemption Cmdlet 來取得名為 PolicyExemption07 的原則豁免。 命令會將該物件儲存在$PolicyExemption變數中。 最後一個命令會更新$ResourceGroup ResourceId 屬性所識別之資源群組上的原則豁免顯示名稱。

範例 2：更新到期日時間

$NextMonth = (Get-Date).AddMonths(1)
$PolicyExemption = Get-AzPolicyExemption -Name 'PolicyExemption07'
Set-AzPolicyExemption -Id $PolicyExemption.ResourceId -ExpiresOn $NextMonth

第一個命令會使用 Get-Date Cmdlet 取得目前的日期時間，並將 1 個月新增至目前的日期時間。命令會將該物件儲存在$NextMonth變數中。 第二個命令會使用 Get-AzPolicyExemption Cmdlet 來取得名為 PolicyExemption07 的原則豁免。 命令會將該物件儲存在$PolicyExemption變數中。 最後一個命令會更新預設訂用帳戶上原則豁免的到期日時間。

範例 3：清除到期日時間

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

第一個命令會使用 Get-AzPolicyExemption Cmdlet 取得名為 PolicyExemption07 的原則豁免。 命令會將該物件儲存在$PolicyExemption變數中。 第二個命令會清除預設訂用帳戶上原則豁免的到期日時間。 更新的豁免永遠不會過期。

範例 4：更新到期類別

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

第一個命令會使用 Get-AzPolicyExemption Cmdlet 取得名為 PolicyExemption07 的原則豁免。 命令會將該物件儲存在$PolicyExemption變數中。 第二個命令會更新預設訂用帳戶上原則豁免的到期類別。 更新的豁免永遠不會過期。

參數

-ApiVersion

設定時，表示要使用的資源提供者 API 版本。 如果未指定，API 版本會自動判斷為最新的可用版本。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ClearExpiration

如果設定，此參數會清除更新原則豁免的到期日期和時間。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

執行 Cmdlet 之前先提示您確認。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

用於與 Azure 通訊的認證、帳戶、租用戶和訂用帳戶。

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

更新原則豁免的描述。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DisplayName

更新原則豁免的顯示名稱。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ExemptionCategory

已更新原則豁免的原則豁免類別。 可能的值為「豁免」和「緩和」。

Type:String
Accepted values:Waiver, Mitigated
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ExpiresOn

更新原則豁免的到期日期和時間 （UTC ISO 8601 格式 yyyy-MM-ddTHH：mm：ssZ）。

Type:Nullable<T>[DateTime]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Id

要更新的完整原則豁免標識符，包括範圍，例如 /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Authorization/policyExemptions/{policyExemptionName}。

Type:String
Aliases:ResourceId
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

要更新另一個 Cmdlet 輸出的原則豁免物件。

Type:PsPolicyExemption
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Metadata

更新原則豁免的元數據。 這可以是包含元數據 JSON 的檔案路徑，或是作為 JSON 字串的元數據。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

要更新的原則豁免名稱。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PolicyDefinitionReferenceId

當相關聯的原則指派是針對原則集 （initiative） 時，原則定義參考標識符清單。

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Pre

設定時，表示 Cmdlet 在自動判斷要使用的版本時，應該使用發行前版本 API 版本。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Scope

更新的原則豁免範圍，例如 /providers/managementGroups/{managementGroupName}，預設為目前的訂用帳戶。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

顯示執行 Cmdlet 後會發生的情況。 未執行 Cmdlet。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

輸入

String

String[]

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

SwitchParameter

PsPolicyExemption

輸出

PsPolicyExemption