你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.Authorization policySetDefinitions 2024-05-01
Bicep 资源定义
可以使用目标操作部署 policySetDefinitions 资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Authorization/policySetDefinitions 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Authorization/policySetDefinitions@2024-05-01' = {
name: 'string'
properties: {
description: 'string'
displayName: 'string'
metadata: any(Azure.Bicep.Types.Concrete.AnyType)
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'
}
}
policyDefinitionGroups: [
{
additionalMetadataId: 'string'
category: 'string'
description: 'string'
displayName: 'string'
name: 'string'
}
]
policyDefinitions: [
{
definitionVersion: 'string'
groupNames: [
'string'
]
parameters: {
{customized property}: {
value: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
policyDefinitionId: 'string'
policyDefinitionReferenceId: 'string'
}
]
policyType: 'string'
version: 'string'
versions: [
'string'
]
}
}
属性值
Microsoft.Authorization/policySetDefinitions
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 资源名称 | 字符串 约束： 模式 = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ （必需） |
| 性能 | 策略集定义属性。 | PolicySetDefinitionProperties |
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 | 通过门户分配策略定义时使用。 提供可供用户选择的值的上下文感知列表。 | 字符串 |
ParameterValues
| 名字 | 描述 | 价值 |
|---|
ParameterValuesValue
| 名字 | 描述 | 价值 |
|---|---|---|
| 价值 | 参数的值。 | 任何 |
PolicyDefinitionGroup
| 名字 | 描述 | 价值 |
|---|---|---|
| additionalMetadataId | 包含有关组的其他元数据的资源的资源 ID。 | 字符串 |
| 类别 | 组的类别。 | 字符串 |
| 描述 | 组的说明。 | 字符串 |
| displayName | 组的显示名称。 | 字符串 |
| 名字 | 组的名称。 | string （必需） |
PolicyDefinitionReference
| 名字 | 描述 | 价值 |
|---|---|---|
| definitionVersion | 要使用的策略定义的版本。 | 字符串 |
| groupNames | 此策略定义引用所属的组的名称。 | string[] |
| 参数 | 引用的策略规则的参数值。 键是参数名称。 | ParameterValues |
| policyDefinitionId | 策略定义或策略集定义的 ID。 | string （必需） |
| policyDefinitionReferenceId | 此策略定义引用的唯一 ID（在策略集定义中）。 | 字符串 |
PolicySetDefinitionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 描述 | 策略集定义说明。 | 字符串 |
| displayName | 策略集定义的显示名称。 | 字符串 |
| 元数据 | 策略集定义元数据。 元数据是一个开放结束的对象，通常是键值对的集合。 | 任何 |
| 参数 | 可在策略定义引用中使用的策略集定义参数。 | ParameterDefinitions |
| policyDefinitionGroups | 描述策略集定义中的策略定义引用组的元数据。 | PolicyDefinitionGroup[] |
| policyDefinitions | 策略定义引用的数组。 | PolicyDefinitionReference[] （必需） |
| policyType | 策略集定义的类型。 可能的值为 NotSpecified、BuiltIn、Custom 和 Static。 | “BuiltIn” “Custom” “NotSpecified” “Static” |
| 版本 | 策略以 #.#.# 格式设置定义版本。 | 字符串 |
| 版本 | 此策略集定义的可用版本列表。 | string[] |
ARM 模板资源定义
可以使用目标操作部署 policySetDefinitions 资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Authorization/policySetDefinitions 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.Authorization/policySetDefinitions",
"apiVersion": "2024-05-01",
"name": "string",
"properties": {
"description": "string",
"displayName": "string",
"metadata": {},
"parameters": {
"{customized property}": {
"allowedValues": [ {} ],
"defaultValue": {},
"metadata": {
"assignPermissions": "bool",
"description": "string",
"displayName": "string",
"strongType": "string"
},
"schema": {},
"type": "string"
}
},
"policyDefinitionGroups": [
{
"additionalMetadataId": "string",
"category": "string",
"description": "string",
"displayName": "string",
"name": "string"
}
],
"policyDefinitions": [
{
"definitionVersion": "string",
"groupNames": [ "string" ],
"parameters": {
"{customized property}": {
"value": {}
}
},
"policyDefinitionId": "string",
"policyDefinitionReferenceId": "string"
}
],
"policyType": "string",
"version": "string",
"versions": [ "string" ]
}
}
属性值
Microsoft.Authorization/policySetDefinitions
| 名字 | 描述 | 价值 |
|---|---|---|
| apiVersion | API 版本 | '2024-05-01' |
| 名字 | 资源名称 | 字符串 约束： 模式 = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ （必需） |
| 性能 | 策略集定义属性。 | PolicySetDefinitionProperties |
| 类型 | 资源类型 | “Microsoft.Authorization/policySetDefinitions” |
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 | 通过门户分配策略定义时使用。 提供可供用户选择的值的上下文感知列表。 | 字符串 |
ParameterValues
| 名字 | 描述 | 价值 |
|---|
ParameterValuesValue
| 名字 | 描述 | 价值 |
|---|---|---|
| 价值 | 参数的值。 | 任何 |
PolicyDefinitionGroup
| 名字 | 描述 | 价值 |
|---|---|---|
| additionalMetadataId | 包含有关组的其他元数据的资源的资源 ID。 | 字符串 |
| 类别 | 组的类别。 | 字符串 |
| 描述 | 组的说明。 | 字符串 |
| displayName | 组的显示名称。 | 字符串 |
| 名字 | 组的名称。 | string （必需） |
PolicyDefinitionReference
| 名字 | 描述 | 价值 |
|---|---|---|
| definitionVersion | 要使用的策略定义的版本。 | 字符串 |
| groupNames | 此策略定义引用所属的组的名称。 | string[] |
| 参数 | 引用的策略规则的参数值。 键是参数名称。 | ParameterValues |
| policyDefinitionId | 策略定义或策略集定义的 ID。 | string （必需） |
| policyDefinitionReferenceId | 此策略定义引用的唯一 ID（在策略集定义中）。 | 字符串 |
PolicySetDefinitionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 描述 | 策略集定义说明。 | 字符串 |
| displayName | 策略集定义的显示名称。 | 字符串 |
| 元数据 | 策略集定义元数据。 元数据是一个开放结束的对象，通常是键值对的集合。 | 任何 |
| 参数 | 可在策略定义引用中使用的策略集定义参数。 | ParameterDefinitions |
| policyDefinitionGroups | 描述策略集定义中的策略定义引用组的元数据。 | PolicyDefinitionGroup[] |
| policyDefinitions | 策略定义引用的数组。 | PolicyDefinitionReference[] （必需） |
| policyType | 策略集定义的类型。 可能的值为 NotSpecified、BuiltIn、Custom 和 Static。 | “BuiltIn” “Custom” “NotSpecified” “Static” |
| 版本 | 策略以 #.#.# 格式设置定义版本。 | 字符串 |
| 版本 | 此策略集定义的可用版本列表。 | string[] |
Terraform （AzAPI 提供程序）资源定义
可以使用目标操作部署 policySetDefinitions 资源类型：
订阅 租户 管理组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Authorization/policySetDefinitions 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Authorization/policySetDefinitions@2024-05-01"
name = "string"
body = jsonencode({
properties = {
description = "string"
displayName = "string"
metadata = ?
parameters = {
{customized property} = {
allowedValues = [
?
]
defaultValue = ?
metadata = {
assignPermissions = bool
description = "string"
displayName = "string"
strongType = "string"
}
schema = ?
type = "string"
}
}
policyDefinitionGroups = [
{
additionalMetadataId = "string"
category = "string"
description = "string"
displayName = "string"
name = "string"
}
]
policyDefinitions = [
{
definitionVersion = "string"
groupNames = [
"string"
]
parameters = {
{customized property} = {
value = ?
}
}
policyDefinitionId = "string"
policyDefinitionReferenceId = "string"
}
]
policyType = "string"
version = "string"
versions = [
"string"
]
}
})
}
属性值
Microsoft.Authorization/policySetDefinitions
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 资源名称 | 字符串 约束： 模式 = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ （必需） |
| 性能 | 策略集定义属性。 | PolicySetDefinitionProperties |
| 类型 | 资源类型 | “Microsoft.Authorization/policySetDefinitions@2024-05-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 | 通过门户分配策略定义时使用。 提供可供用户选择的值的上下文感知列表。 | 字符串 |
ParameterValues
| 名字 | 描述 | 价值 |
|---|
ParameterValuesValue
| 名字 | 描述 | 价值 |
|---|---|---|
| 价值 | 参数的值。 | 任何 |
PolicyDefinitionGroup
| 名字 | 描述 | 价值 |
|---|---|---|
| additionalMetadataId | 包含有关组的其他元数据的资源的资源 ID。 | 字符串 |
| 类别 | 组的类别。 | 字符串 |
| 描述 | 组的说明。 | 字符串 |
| displayName | 组的显示名称。 | 字符串 |
| 名字 | 组的名称。 | string （必需） |
PolicyDefinitionReference
| 名字 | 描述 | 价值 |
|---|---|---|
| definitionVersion | 要使用的策略定义的版本。 | 字符串 |
| groupNames | 此策略定义引用所属的组的名称。 | string[] |
| 参数 | 引用的策略规则的参数值。 键是参数名称。 | ParameterValues |
| policyDefinitionId | 策略定义或策略集定义的 ID。 | string （必需） |
| policyDefinitionReferenceId | 此策略定义引用的唯一 ID（在策略集定义中）。 | 字符串 |
PolicySetDefinitionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 描述 | 策略集定义说明。 | 字符串 |
| displayName | 策略集定义的显示名称。 | 字符串 |
| 元数据 | 策略集定义元数据。 元数据是一个开放结束的对象，通常是键值对的集合。 | 任何 |
| 参数 | 可在策略定义引用中使用的策略集定义参数。 | ParameterDefinitions |
| policyDefinitionGroups | 描述策略集定义中的策略定义引用组的元数据。 | PolicyDefinitionGroup[] |
| policyDefinitions | 策略定义引用的数组。 | PolicyDefinitionReference[] （必需） |
| policyType | 策略集定义的类型。 可能的值为 NotSpecified、BuiltIn、Custom 和 Static。 | “BuiltIn” “Custom” “NotSpecified” “Static” |
| 版本 | 策略以 #.#.# 格式设置定义版本。 | 字符串 |
| 版本 | 此策略集定义的可用版本列表。 | string[] |