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

New-AzPolicyDefinition

参考

模块:: Az.Resources

创建策略定义。

语法

New-AzPolicyDefinition
   -Name <String>
   [-DisplayName <String>]
   [-Description <String>]
   -Policy <String>
   [-Metadata <String>]
   [-Parameter <String>]
   [-Mode <String>]
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

New-AzPolicyDefinition
   -Name <String>
   [-DisplayName <String>]
   [-Description <String>]
   -Policy <String>
   [-Metadata <String>]
   [-Parameter <String>]
   [-Mode <String>]
   -ManagementGroupName <String>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

New-AzPolicyDefinition
   -Name <String>
   [-DisplayName <String>]
   [-Description <String>]
   -Policy <String>
   [-Metadata <String>]
   [-Parameter <String>]
   [-Mode <String>]
   -SubscriptionId <Guid>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

说明

New-AzPolicyDefinition cmdlet 创建一个策略定义，其中包含 JavaScript 对象表示法（JSON）格式的策略规则。

示例

示例 1：使用策略文件创建策略定义

<#{
   "if": {
      "field": "location",
      "notIn": ["eastus", "westus", "centralus"]
   },
   "then": {
      "effect": "audit"
   }
}#>
New-AzPolicyDefinition -Name 'LocationDefinition' -Policy C:\LocationPolicy.json

此命令创建名为 LocationDefinition 的策略定义，其中包含 C：\LocationPolicy.json 中指定的策略规则。上面提供了LocationPolicy.json文件的示例内容。支持三种文件格式：

仅策略规则（如上例）。
策略属性对象。编辑策略定义时，此格式将显示在门户中，并可能包括参数。
完整策略对象。此格式由 Azure Policy 导出函数生成，可以包含参数。

注意：命令行（例如参数、元数据）上提供的值将替代文件中存在的相应值。

示例 2：使用内联参数创建参数化策略定义

<#{
   "if": {
      "field": "location",
      "notIn": "[parameters('listOfAllowedLocations')]"
   },
   "then": {
      "effect": "audit"
   }
}#>
New-AzPolicyDefinition -Name 'LocationDefinition' -Policy C:\LocationPolicy.json -Parameter '{ "listOfAllowedLocations": { "type": "array" } }'

此命令创建名为 LocationDefinition 的策略定义，其中包含 C：\LocationPolicy.json 中指定的策略规则。策略规则的参数定义内联提供。

示例 3：在管理组中内联创建策略定义

New-AzPolicyDefinition -Name 'VMPolicyDefinition' -ManagementGroupName Dept42 -DisplayName 'Virtual Machine policy definition' -Policy '{"if":{"field":"type","equals":"Microsoft.Compute/virtualMachines"},"then":{"effect":"deny"}}'

此命令在管理组 Dept42 中创建名为 VMPolicyDefinition 的策略定义。该命令以有效 JSON 格式的字符串指定策略。

示例 4：使用元数据内联创建策略定义

New-AzPolicyDefinition -Name 'VMPolicyDefinition' -Metadata '{"category":"Virtual Machine"}' -Policy '{"if":{"field":"type","equals":"Microsoft.Compute/virtualMachines"},"then":{"effect":"deny"}}'

Name               : VMPolicyDefinition
ResourceId         : /subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Authorization/policyDefinitions/VMPolicyDefinition
ResourceName       : VMPolicyDefinition
ResourceType       : Microsoft.Authorization/policyDefinitions
SubscriptionId     : 11111111-1111-1111-1111-111111111111
Properties         : @{displayName=VMPolicyDefinition; policyType=Custom; mode=All; metadata=; policyRule=}
PolicyDefinitionId : /subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Authorization/policyDefinitions/VMPolicyDefinition

此命令创建名为 VMPolicyDefinition 的策略定义，其中包含指示其类别为“虚拟机”的元数据。该命令以有效 JSON 格式的字符串指定策略。

示例 5：使用模式内联创建策略定义

New-AzPolicyDefinition -Name 'TagsPolicyDefinition' -Policy '{"if":{"value":"[less(length(field(''tags'')), 3)]","equals":true},"then":{"effect":"deny"}}' -Mode Indexed

Name               : TagsPolicyDefinition
ResourceId         : /subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Authorization/policyDefinitions/TagsPolicyDefinition
ResourceName       : TagsPolicyDefinition
ResourceType       : Microsoft.Authorization/policyDefinitions
SubscriptionId     : 11111111-1111-1111-1111-111111111111
Properties         : @{displayName=TagsPolicyDefinition; policyType=Custom; mode=Indexed; metadata=; parameters=; policyRule=}
PolicyDefinitionId : /subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Authorization/policyDefinitions/TagsPolicyDefinition

此命令创建一个名为 TagsPolicyDefinition 的策略定义，该模式为“Indexed”，指示应仅针对支持标记和位置的资源类型评估策略。

参数

-ApiVersion

指定要使用的资源提供程序 API 的版本。如果未指定版本，此 cmdlet 将使用最新的可用版本。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

指定策略定义的说明。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-DisplayName

指定策略定义的显示名称。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ManagementGroupName

新策略定义的管理组的名称。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Metadata

策略定义的元数据。这可以是包含元数据的文件名的路径，也可以是元数据作为字符串的路径

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Mode

策略定义的模式

Type:	String
Position:	Named
Default value:	All
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

指定策略定义的名称。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Parameter

策略定义的参数声明。这可以是包含参数声明的文件名的路径，也可以是参数声明为字符串的路径。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Policy

指定策略定义的策略规则。可以指定.json文件的路径或 JSON 格式包含策略的字符串。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Pre

指示此 cmdlet 在自动确定要使用的版本时会考虑预发布 API 版本。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

新策略定义的订阅 ID。

Type:	Nullable<T>[Guid]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

输入

String

Nullable<T>[[System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

输出

PSObject

New-AzPolicyDefinition

语法

说明

示例

示例 1：使用策略文件创建策略定义

示例 2：使用内联参数创建参数化策略定义

示例 3：在管理组中内联创建策略定义

示例 4：使用元数据内联创建策略定义

示例 5：使用模式内联创建策略定义

参数

-ApiVersion

-DefaultProfile

-Description

-DisplayName

-ManagementGroupName

-Metadata

-Mode

-Name

-Parameter

-Policy

-Pre

-SubscriptionId

输入

输出

反馈

其他资源

New-AzPolicyDefinition

语法

说明

示例

示例 1：使用策略文件创建策略定义

示例 2：使用内联参数创建参数化策略定义

示例 3：在管理组中内联创建策略定义

示例 4：使用元数据内联创建策略定义

示例 5：使用模式内联创建策略定义

参数

-ApiVersion

-DefaultProfile

-Description

-DisplayName

-ManagementGroupName

-Metadata

-Mode

-Name

-Parameter

-Policy

-Pre

-SubscriptionId

输入

输出

相关链接

反馈

其他资源