通过

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

Get-AzPolicyDefinition

模块:
Az.Resources Module

获取策略集定义。

语法

Name （默认值） 

Get-AzPolicyDefinition
    [-Name <String>]
    [-BackwardCompatible]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

ManagementGroupName 

Get-AzPolicyDefinition
    -ManagementGroupName <String>
    [-Name <String>]
    [-BackwardCompatible]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

SubscriptionId 

Get-AzPolicyDefinition
    -SubscriptionId <String>
    [-Name <String>]
    [-BackwardCompatible]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Version 

Get-AzPolicyDefinition
    -Version <String>
    [-Name <String>]
    [-Id <String>]
    [-BackwardCompatible]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

ListVersion 

Get-AzPolicyDefinition
    [-Name <String>]
    [-Id <String>]
    [-ListVersion]
    [-BackwardCompatible]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Id 

Get-AzPolicyDefinition
    -Id <String>
    [-BackwardCompatible]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Builtin 

Get-AzPolicyDefinition
    [-SubscriptionId <String>]
    [-ManagementGroupName <String>]
    [-Builtin]
    [-BackwardCompatible]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Custom 

Get-AzPolicyDefinition
    [-SubscriptionId <String>]
    [-ManagementGroupName <String>]
    [-Custom]
    [-BackwardCompatible]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Static 

Get-AzPolicyDefinition
    [-SubscriptionId <String>]
    [-ManagementGroupName <String>]
    [-Static]
    [-BackwardCompatible]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

说明

Get-AzPolicyDefinition cmdlet 获取策略集定义的集合或由名称或 ID 标识的特定策略集定义。

示例

示例 1：获取所有策略定义

Get-AzPolicyDefinition

此命令获取所有策略定义。

示例 2：按名称从当前订阅获取策略定义

Get-AzPolicyDefinition -Name 'VMPolicyDefinition'

此命令从当前默认订阅获取名为 VMPolicyDefinition 的策略定义。

示例 3：按名称从管理组获取策略定义

Get-AzPolicyDefinition -Name 'VMPolicyDefinition' -ManagementGroupName 'Dept42'

此命令从名为 Dept42 的管理组获取名为 VMPolicyDefinition 的策略定义。

示例 4：从订阅获取所有内置策略定义

Get-AzPolicyDefinition -SubscriptionId '3bf44b72-c631-427a-b8c8-53e2595398ca' -Builtin

此命令从 ID 为 3bf44b72-c631-427a-b8c8-53e2595398ca 的订阅获取所有内置策略定义。

示例 5：从给定类别获取策略定义

Get-AzPolicyDefinition | Where-Object {$_.Properties.metadata.category -eq 'Tags'}

此命令获取类别 标记中的所有策略定义。

示例 6：获取格式为列表的所有策略定义的显示名称、说明、策略类型和元数据

Get-AzPolicyDefinition | Select-Object -Property DisplayName, Description, PolicyType, Metadata | Format-List

如果需要查找 Azure Policy 定义的读者友好 DisplayName 属性，此命令非常有用。 可以分析 Metadata 属性以发现策略定义的版本号和类别分配。

示例 7：[Backcompat] 获取格式为列表的所有策略定义的显示名称、说明、策略类型和元数据

Get-AzPolicyDefinition -BackwardCompatible | Select-Object -ExpandProperty properties | Select-Object -Property DisplayName, Description, PolicyType, Metadata | Format-List

如果需要查找 Azure Policy 定义的读者友好 DisplayName 属性，此命令非常有用。 可以分析 Metadata 属性以发现策略定义的版本号和类别分配。

参数

-BackwardCompatible

导致 cmdlet 使用旧格式在属性包对象中放置特定于策略的属性返回项目。

参数属性

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

参数集

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

-Builtin

导致 cmdlet 仅返回内置策略定义。

参数属性

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

参数集

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

-Custom

导致 cmdlet 仅返回自定义策略定义。

参数属性

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

参数集

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

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

参数属性

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

参数集

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

-Id

要获取的策略定义的完整 ID。

参数属性

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

参数集

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

-ListVersion

导致 cmdlet 仅返回自定义策略定义。

参数属性

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

参数集

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

-ManagementGroupName

管理组的名称。

参数属性

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

参数集

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

-Name

要获取的策略定义的名称。

参数属性

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

参数集

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

-Static

导致 cmdlet 仅返回静态策略定义。

参数属性

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

参数集

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

-SubscriptionId

目标订阅的 ID。

参数属性

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

参数集

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

-Version

#.#.# 格式的策略定义版本。

参数属性

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

参数集

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

CommonParameters

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

输入

SwitchParameter

String

输出

IPolicyDefinition