Update-AzPolicySetDefinition

參考

模組:: Az.Resources

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

語法

Update-AzPolicySetDefinition
      -Name <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-PolicyDefinition <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-PolicyDefinitionGroup <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicySetDefinition
      -Name <String>
      -ManagementGroupName <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-PolicyDefinition <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-PolicyDefinitionGroup <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicySetDefinition
      -Name <String>
      -SubscriptionId <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-PolicyDefinition <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-PolicyDefinitionGroup <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicySetDefinition
      -Id <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-PolicyDefinition <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-PolicyDefinitionGroup <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicySetDefinition
      [-DisplayName <String>]
      [-Description <String>]
      [-PolicyDefinition <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-PolicyDefinitionGroup <String>]
      [-BackwardCompatible]
      -InputObject <IPolicySetDefinition>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

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

範例

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

$PolicySetDefinition = Get-AzPolicySetDefinition -ResourceId '/subscriptions/mySub/Microsoft.Authorization/policySetDefinitions/myPSSetDefinition'
Update-AzPolicySetDefinition -Id $PolicySetDefinition.ResourceId -Description 'Updated policy to not allow virtual machine creation'

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

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

Update-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -Metadata '{"category":"Virtual Machine"}'

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

範例 3：更新原則集定義的群組

Update-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -GroupDefinition '[{ "name": "group1", "displayName": "Virtual Machine Security" }, { "name": "group2" }]'

此命令會更新名為 VMPolicySetDefinition 的原則集定義群組。

範例 4：使用哈希表更新原則集定義的群組

$groupsJson = ConvertTo-Json @{ name = "group1"; displayName = "Virtual Machine Security" }, @{ name = "group2" }
Update-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -GroupDefinition $groupsJson

此命令會從哈希表更新名為 VMPolicySetDefinition 的原則集定義群組。

範例 5：[Backcompat] 更新原則集定義的元數據

Set-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -Metadata '{"category":"Virtual Machine"}'

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

參數

-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

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

-ManagementGroupName

管理群組的標識碼。

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

-Metadata

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

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

-Name

要更新的原則集定義名稱。

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

-Parameter

原則集所使用之參數的參數定義。索引鍵是參數名稱。

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

-PolicyDefinition

JSON 字串格式的原則定義數位。

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

-PolicyDefinitionGroup

元數據，描述原則集定義內的原則定義參考群組。若要建構，請參閱 POLICYDEFINITIONGROUP 屬性和建立哈希表的 NOTES 一節。

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

-SubscriptionId

目標訂用帳戶的標識碼。

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

-WhatIf

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

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

輸入

IPolicySetDefinition

String

輸出