Update-AzPolicyDefinition

參考

模組:: Az.Resources

這項作業會以指定名稱更新指定訂用帳戶或管理群組中的現有原則定義。

語法

Update-AzPolicyDefinition
      -Name <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicyDefinition
      -Name <String>
      -SubscriptionId <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicyDefinition
      -Name <String>
      -ManagementGroupName <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicyDefinition
      -Id <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicyDefinition
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      -InputObject <IPolicyDefinition>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

這項作業會以指定名稱更新指定訂用帳戶或管理群組中的現有原則定義。

範例

範例 1：更新原則定義的描述

$PolicyDefinition = Get-AzPolicyDefinition -Name 'VMPolicyDefinition'
Update-AzPolicyDefinition -Id $PolicyDefinition.ResourceId -Description 'Updated policy to not allow virtual machine creation'

第一個命令會使用 Get-AzPolicyDefinition Cmdlet 來取得名為 VMPolicyDefinition 的原則定義。命令會將該物件儲存在 $PolicyDefinition變數中。第二個命令會更新 $PolicyDefinition ResourceId 屬性所識別的原則定義描述。

範例 2：更新原則定義的模式

Update-AzPolicyDefinition -Name 'VMPolicyDefinition' -Mode 'All'

此命令會使用 Update-AzPolicyDefinition Cmdlet，將其 mode 屬性設定為 'All'，以更新名為 VMPolicyDefinition 的原則定義。

範例 3：更新原則定義的元數據

Update-AzPolicyDefinition -Name 'VMPolicyDefinition' -Metadata '{"category":"Virtual Machine"}'

此命令會更新名為 VMPolicyDefinition 的原則定義元數據，以指出其類別為「虛擬機」。

範例 3：[Backcompat] 更新原則定義的模式

Set-AzPolicyDefinition -Name 'VMPolicyDefinition' -Mode 'All'

此命令會使用 Update-AzPolicyDefinition Cmdlet 的 Set-AzPolicyDefinition 別名，將其 mode 屬性設定為 'All'，以更新名為 VMPolicyDefinition 的原則定義。

參數

-BackwardCompatible

導致 Cmdlet 使用舊版格式將原則特定屬性放在屬性包對象中傳回成品。

類型:	SwitchParameter
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-Confirm

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

類型:	SwitchParameter
別名:	cf
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-DefaultProfile

DefaultProfile 參數無法運作。如果針對不同的訂用帳戶執行 Cmdlet，請使用 SubscriptionId 參數。

類型:	PSObject
別名:	AzureRMContext, AzureCredential
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-Description

原則定義描述。

類型:	String
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	True
接受萬用字元:	False

-DisplayName

原則定義的顯示名稱。

類型:	String
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	True
接受萬用字元:	False

-Id

要更新的原則定義資源標識碼。

類型:	String
別名:	ResourceId
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	False

-InputObject

類型:	IPolicyDefinition
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	False

-ManagementGroupName

管理群組的標識碼。

類型:	String
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	False

-Metadata

原則定義元數據。元數據是開放式物件，通常是索引鍵值組的集合。

類型:	String
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	True
接受萬用字元:	False

-Mode

原則定義模式。有些範例包括 All、Indexed、Microsoft.KeyVault.Data。

類型:	String
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	True
接受萬用字元:	False

-Name

要更新的原則定義名稱。

類型:	String
別名:	PolicyDefinitionName
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	False

-Parameter

原則規則中使用的參數參數定義。索引鍵是參數名稱。

類型:	String
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-Policy

原則規則。

類型:	String
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	True
接受萬用字元:	False

-SubscriptionId

目標訂用帳戶的標識碼。

類型:	String
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	False

-WhatIf

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

類型:	SwitchParameter
別名:	wi
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

輸入

IPolicyDefinition

String

輸出