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

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

说明

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

示例

示例 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 将其模式属性设置为“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 别名将其模式属性设置为“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

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

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

-InputObject

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

-ManagementGroupName

管理组的 ID。

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

目标订阅的 ID。

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

-WhatIf

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

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

输入

IPolicyDefinition

String

输出