你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.Authorization policyDefinitions 2025-01-01
Bicep 资源定义
可以使用目标操作部署 policyDefinitions 资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Authorization/policyDefinitions 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Authorization/policyDefinitions@2025-01-01' = {
name: 'string'
properties: {
description: 'string'
displayName: 'string'
metadata: any(Azure.Bicep.Types.Concrete.AnyType)
mode: 'string'
parameters: {
{customized property}: {
allowedValues: [
any(Azure.Bicep.Types.Concrete.AnyType)
]
defaultValue: any(Azure.Bicep.Types.Concrete.AnyType)
metadata: {
assignPermissions: bool
description: 'string'
displayName: 'string'
strongType: 'string'
}
schema: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'string'
}
}
policyRule: any(Azure.Bicep.Types.Concrete.AnyType)
policyType: 'string'
version: 'string'
versions: [
'string'
]
}
}
属性值
Microsoft.Authorization/policyDefinitions
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 资源名称 | 字符串 约束： 模式 = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ （必需） |
| 性能 | 策略定义属性。 | PolicyDefinitionProperties |
ParameterDefinitions
| 名字 | 描述 | 价值 |
|---|
ParameterDefinitionsValue
| 名字 | 描述 | 价值 |
|---|---|---|
| allowedValues | 参数的允许值。 | any[] |
| defaultValue | 如果未提供任何值，则为参数的默认值。 | 任何 |
| 元数据 | 参数的常规元数据。 | ParameterDefinitionsValueMetadata |
| 图式 | 使用自定义 JSON 架构在分配期间提供参数输入的验证。 此属性仅支持对象类型参数，并遵循 Json.NET Schema 2019-09 实现。 可以在 https://json-schema.org/ 了解有关在 https://www.jsonschemavalidator.net/使用架构的详细信息，并测试草稿架构。 | 任何 |
| 类型 | 参数的数据类型。 | “Array” “Boolean” “DateTime” “Float” “Integer” “Object” “String” |
ParameterDefinitionsValueMetadata
| 名字 | 描述 | 价值 |
|---|---|---|
| assignPermissions | 设置为 true，让 Azure 门户在策略分配期间基于此参数的资源 ID 或资源范围值创建角色分配。 如果要在分配范围之外分配权限，此属性非常有用。 | bool |
| 描述 | 参数的说明。 | 字符串 |
| displayName | 参数的显示名称。 | 字符串 |
| strongType | 通过门户分配策略定义时使用。 提供可供用户选择的值的上下文感知列表。 | 字符串 |
PolicyDefinitionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 描述 | 策略定义说明。 | 字符串 |
| displayName | 策略定义的显示名称。 | 字符串 |
| 元数据 | 策略定义元数据。 元数据是一个开放结束的对象，通常是键值对的集合。 | 任何 |
| 模式 | 策略定义模式。 一些示例包括 All、Indexed、Microsoft.KeyVault.Data。 | 字符串 |
| 参数 | 策略规则中使用的参数的参数定义。 键是参数名称。 | ParameterDefinitions |
| policyRule | 策略规则。 | 任何 |
| policyType | 策略定义的类型。 可能的值为 NotSpecified、BuiltIn、Custom 和 Static。 | “BuiltIn” “Custom” “NotSpecified” “Static” |
| 版本 | #.#.# 格式的策略定义版本。 | 字符串 |
| 版本 | 此策略定义的可用版本列表。 | string[] |
快速入门示例
以下快速入门示例部署此资源类型。
| Bicep 文件 | 描述 |
|---|---|
| 创建 Azure 虚拟网络管理器和示例 VNET | 此模板将 Azure 虚拟网络管理器和示例虚拟网络部署到命名资源组中。 它支持多个连接拓扑和网络组成员身份类型。 |
| 部署策略 def 并将其分配给多个 Mgmt 组 | 此模板是一个管理组级模板，用于创建策略定义并将该策略分配给多个管理组。 |
| 部署策略定义并分配给管理组 | 此模板是一个管理组级模板，用于创建策略定义并将该策略分配给目标管理组。 目前，无法通过 Azure 门户部署此模板。 |
ARM 模板资源定义
可以使用目标操作部署 policyDefinitions 资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Authorization/policyDefinitions 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.Authorization/policyDefinitions",
"apiVersion": "2025-01-01",
"name": "string",
"properties": {
"description": "string",
"displayName": "string",
"metadata": {},
"mode": "string",
"parameters": {
"{customized property}": {
"allowedValues": [ {} ],
"defaultValue": {},
"metadata": {
"assignPermissions": "bool",
"description": "string",
"displayName": "string",
"strongType": "string"
},
"schema": {},
"type": "string"
}
},
"policyRule": {},
"policyType": "string",
"version": "string",
"versions": [ "string" ]
}
}
属性值
Microsoft.Authorization/policyDefinitions
| 名字 | 描述 | 价值 |
|---|---|---|
| apiVersion | API 版本 | '2025-01-01' |
| 名字 | 资源名称 | 字符串 约束： 模式 = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ （必需） |
| 性能 | 策略定义属性。 | PolicyDefinitionProperties |
| 类型 | 资源类型 | “Microsoft.Authorization/policyDefinitions” |
ParameterDefinitions
| 名字 | 描述 | 价值 |
|---|
ParameterDefinitionsValue
| 名字 | 描述 | 价值 |
|---|---|---|
| allowedValues | 参数的允许值。 | any[] |
| defaultValue | 如果未提供任何值，则为参数的默认值。 | 任何 |
| 元数据 | 参数的常规元数据。 | ParameterDefinitionsValueMetadata |
| 图式 | 使用自定义 JSON 架构在分配期间提供参数输入的验证。 此属性仅支持对象类型参数，并遵循 Json.NET Schema 2019-09 实现。 可以在 https://json-schema.org/ 了解有关在 https://www.jsonschemavalidator.net/使用架构的详细信息，并测试草稿架构。 | 任何 |
| 类型 | 参数的数据类型。 | “Array” “Boolean” “DateTime” “Float” “Integer” “Object” “String” |
ParameterDefinitionsValueMetadata
| 名字 | 描述 | 价值 |
|---|---|---|
| assignPermissions | 设置为 true，让 Azure 门户在策略分配期间基于此参数的资源 ID 或资源范围值创建角色分配。 如果要在分配范围之外分配权限，此属性非常有用。 | bool |
| 描述 | 参数的说明。 | 字符串 |
| displayName | 参数的显示名称。 | 字符串 |
| strongType | 通过门户分配策略定义时使用。 提供可供用户选择的值的上下文感知列表。 | 字符串 |
PolicyDefinitionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 描述 | 策略定义说明。 | 字符串 |
| displayName | 策略定义的显示名称。 | 字符串 |
| 元数据 | 策略定义元数据。 元数据是一个开放结束的对象，通常是键值对的集合。 | 任何 |
| 模式 | 策略定义模式。 一些示例包括 All、Indexed、Microsoft.KeyVault.Data。 | 字符串 |
| 参数 | 策略规则中使用的参数的参数定义。 键是参数名称。 | ParameterDefinitions |
| policyRule | 策略规则。 | 任何 |
| policyType | 策略定义的类型。 可能的值为 NotSpecified、BuiltIn、Custom 和 Static。 | “BuiltIn” “Custom” “NotSpecified” “Static” |
| 版本 | #.#.# 格式的策略定义版本。 | 字符串 |
| 版本 | 此策略定义的可用版本列表。 | string[] |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 描述 |
|---|---|
创建 Azure 虚拟网络管理器和示例 VNET
|
此模板将 Azure 虚拟网络管理器和示例虚拟网络部署到命名资源组中。 它支持多个连接拓扑和网络组成员身份类型。 |
|
部署策略 def 并将其分配给多个 Mgmt 组
|
此模板是一个管理组级模板，用于创建策略定义并将该策略分配给多个管理组。 |
|
部署策略定义并分配给管理组
|
此模板是一个管理组级模板，用于创建策略定义并将该策略分配给目标管理组。 目前，无法通过 Azure 门户部署此模板。 |
Terraform （AzAPI 提供程序）资源定义
可以使用目标操作部署 policyDefinitions 资源类型：
订阅 租户 管理组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Authorization/policyDefinitions 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Authorization/policyDefinitions@2025-01-01"
name = "string"
body = jsonencode({
properties = {
description = "string"
displayName = "string"
metadata = ?
mode = "string"
parameters = {
{customized property} = {
allowedValues = [
?
]
defaultValue = ?
metadata = {
assignPermissions = bool
description = "string"
displayName = "string"
strongType = "string"
}
schema = ?
type = "string"
}
}
policyRule = ?
policyType = "string"
version = "string"
versions = [
"string"
]
}
})
}
属性值
Microsoft.Authorization/policyDefinitions
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 资源名称 | 字符串 约束： 模式 = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ （必需） |
| 性能 | 策略定义属性。 | PolicyDefinitionProperties |
| 类型 | 资源类型 | “Microsoft.Authorization/policyDefinitions@2025-01-01” |
ParameterDefinitions
| 名字 | 描述 | 价值 |
|---|
ParameterDefinitionsValue
| 名字 | 描述 | 价值 |
|---|---|---|
| allowedValues | 参数的允许值。 | any[] |
| defaultValue | 如果未提供任何值，则为参数的默认值。 | 任何 |
| 元数据 | 参数的常规元数据。 | ParameterDefinitionsValueMetadata |
| 图式 | 使用自定义 JSON 架构在分配期间提供参数输入的验证。 此属性仅支持对象类型参数，并遵循 Json.NET Schema 2019-09 实现。 可以在 https://json-schema.org/ 了解有关在 https://www.jsonschemavalidator.net/使用架构的详细信息，并测试草稿架构。 | 任何 |
| 类型 | 参数的数据类型。 | “Array” “Boolean” “DateTime” “Float” “Integer” “Object” “String” |
ParameterDefinitionsValueMetadata
| 名字 | 描述 | 价值 |
|---|---|---|
| assignPermissions | 设置为 true，让 Azure 门户在策略分配期间基于此参数的资源 ID 或资源范围值创建角色分配。 如果要在分配范围之外分配权限，此属性非常有用。 | bool |
| 描述 | 参数的说明。 | 字符串 |
| displayName | 参数的显示名称。 | 字符串 |
| strongType | 通过门户分配策略定义时使用。 提供可供用户选择的值的上下文感知列表。 | 字符串 |
PolicyDefinitionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 描述 | 策略定义说明。 | 字符串 |
| displayName | 策略定义的显示名称。 | 字符串 |
| 元数据 | 策略定义元数据。 元数据是一个开放结束的对象，通常是键值对的集合。 | 任何 |
| 模式 | 策略定义模式。 一些示例包括 All、Indexed、Microsoft.KeyVault.Data。 | 字符串 |
| 参数 | 策略规则中使用的参数的参数定义。 键是参数名称。 | ParameterDefinitions |
| policyRule | 策略规则。 | 任何 |
| policyType | 策略定义的类型。 可能的值为 NotSpecified、BuiltIn、Custom 和 Static。 | “BuiltIn” “Custom” “NotSpecified” “Static” |
| 版本 | #.#.# 格式的策略定义版本。 | 字符串 |
| 版本 | 此策略定义的可用版本列表。 | string[] |