你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Get-AzPolicyDefinition
获取策略定义。
语法
Get-AzPolicyDefinition
[-Name <String>]
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzPolicyDefinition
[-Name <String>]
-ManagementGroupName <String>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzPolicyDefinition
[-Name <String>]
-SubscriptionId <Guid>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzPolicyDefinition
-Id <String>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzPolicyDefinition
[-ManagementGroupName <String>]
[-SubscriptionId <Guid>]
[-Builtin]
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzPolicyDefinition
[-ManagementGroupName <String>]
[-SubscriptionId <Guid>]
[-Custom]
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<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 -ExpandProperty properties | Select-Object -Property DisplayName, Description, PolicyType, Metadata | Format-List
如果需要查找 Azure Policy 定义的读者友好 DisplayName 属性,此命令非常有用。 可以分析 Metadata 属性以发现策略定义的版本号和类别分配。
参数
-ApiVersion
指定要使用的资源提供程序 API 的版本。 如果未指定版本,此 cmdlet 将使用最新的可用版本。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Builtin
将结果列表限制为仅内置策略定义。
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
-Custom
将结果列表限制为仅自定义策略定义。
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
-DefaultProfile
用于与 azure 通信的凭据、帐户、租户和订阅
类型: | IAzureContextContainer |
别名: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Id
指定此 cmdlet 获取的策略定义的完全限定资源 ID。
类型: | String |
别名: | ResourceId |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | True |
接受通配符: | False |
-ManagementGroupName
要获取的策略定义的管理组的名称。
类型: | String |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | True |
接受通配符: | False |
-Name
指定此 cmdlet 获取的策略定义的名称。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-Pre
指示此 cmdlet 在自动确定要使用的版本时会考虑预发布 API 版本。
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-SubscriptionId
要获取的策略定义的订阅 ID。
类型: | Nullable<T>[Guid] |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | True |
接受通配符: | False |
输入
Nullable<T>[[System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]