通过

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

Update-AzPolicyDefinition

模块:
Az.Resources Module

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

语法

Name (默认值) 

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

SubscriptionId 

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

ManagementGroupName 

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

Id 

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

InputObject 

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

说明

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

示例

示例 1：更新策略定义的说明

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

第一个命令使用 Get-AzPolicyDefinition cmdlet 获取名为 VMPolicyDefinition 的策略定义。 该命令将该对象存储在$PolicyDefinition变量中。 第二个命令更新由 $PolicyDefinition 的 Id 属性标识的策略定义的说明。

示例 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
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Confirm

在运行 cmdlet 之前，提示你进行确认。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-DefaultProfile

DefaultProfile 参数不起作用。 如果对其他订阅执行 cmdlet，请使用 SubscriptionId 参数。

参数属性

类型:PSObject
默认值:None
支持通配符:False
不显示:False
别名:AzureRMContext, AzureCredential

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Description

策略定义说明。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:True
来自剩余参数的值:False

-DisplayName

策略定义的显示名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:True
来自剩余参数的值:False

-Id

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

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False
别名:ResourceId

参数集

Id
Position:Named
必需:True
来自管道的值:False
来自管道的值（按属性名称）:True
来自剩余参数的值:False

-InputObject

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

参数属性

类型:IPolicyDefinition
默认值:None
支持通配符:False
不显示:False

参数集

InputObject
Position:Named
必需:True
来自管道的值:True
来自管道的值（按属性名称）:True
来自剩余参数的值:False

-ManagementGroupName

管理组的 ID。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

ManagementGroupName
Position:Named
必需:True
来自管道的值:False
来自管道的值（按属性名称）:True
来自剩余参数的值:False

-Metadata

策略定义元数据。 元数据是一个开放结束的对象，通常是键值对的集合。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:True
来自剩余参数的值:False

-Mode

策略定义模式。 一些示例包括 All、Indexed、Microsoft.KeyVault.Data。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:True
来自剩余参数的值:False

-Name

要更新的策略定义的名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False
别名:PolicyDefinitionName

参数集

Name
Position:Named
必需:True
来自管道的值:False
来自管道的值（按属性名称）:True
来自剩余参数的值:False
SubscriptionId
Position:Named
必需:True
来自管道的值:False
来自管道的值（按属性名称）:True
来自剩余参数的值:False
ManagementGroupName
Position:Named
必需:True
来自管道的值:False
来自管道的值（按属性名称）:True
来自剩余参数的值:False

-Parameter

策略规则中使用的参数的参数定义。 键是参数名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Policy

策略规则。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:True
来自剩余参数的值:False

-SubscriptionId

目标订阅的 ID。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

SubscriptionId
Position:Named
必需:True
来自管道的值:False
来自管道的值（按属性名称）:True
来自剩余参数的值:False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 命令脚本未运行。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:无线

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。

输入

IPolicyDefinition

String

输出

IPolicyDefinition

备注

别名

Set-AzPolicyDefinition