你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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

说明

此操作使用给定名称更新给定订阅或管理组中的现有策略集定义。

示例

示例 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

要更新的策略定义的资源 ID。

类型:	String
别名:	ResourceId
Position:	Named
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-InputObject

类型:	IPolicySetDefinition
Position:	Named
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-ManagementGroupName

管理组的 ID。

类型:	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

目标订阅的 ID。

类型:	String
Position:	Named
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 cmdlet 未运行。

类型:	SwitchParameter
别名:	wi
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

输入

IPolicySetDefinition

String

输出