你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Bicep 资源定义
可以使用目标操作部署 policyDefinitions/versions 资源类型:
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Authorization/policyDefinitions/versions 资源,请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Authorization/policyDefinitions/versions@2025-03-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
description: 'string'
displayName: 'string'
externalEvaluationEnforcementSettings: {
endpointSettings: {
details: any(...)
kind: 'string'
}
missingTokenAction: 'string'
resultLifespan: 'string'
roleDefinitionIds: [
'string'
]
}
metadata: any(...)
mode: 'string'
parameters: {
{customized property}: {
allowedValues: [
any(...)
]
defaultValue: any(...)
metadata: {
assignPermissions: bool
description: 'string'
displayName: 'string'
strongType: 'string'
}
schema: any(...)
type: 'string'
}
}
policyRule: any(...)
policyType: 'string'
version: 'string'
}
}
属性值
Microsoft.Authorization/policyDefinitions/versions
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| 姓名 | 资源名称 | 字符串 约束: 模式 = ^\d+\.\d+\.\d+$ (必需) |
| 父级 | 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。 有关详细信息,请参阅 父资源外部的子资源。 |
类型资源的符号名称:policyDefinitions |
| 属性 | 策略定义版本属性。 | PolicyDefinitionVersionProperties |
ExternalEvaluationEndpointSettings
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| 详 | 终结点的详细信息。 | 任何 |
| 类 | 终结点的类型。 | 字符串 |
ExternalEvaluationEnforcementSettings (外部评估强制设置)
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| endpointSettings | 提供评估结果的外部终结点的设置。 | ExternalEvaluationEndpointSettings |
| missingTokenAction | 评估需要外部评估且缺少令牌的强制策略时该怎么办。 可能的值为 Audit 和 Deny,支持语言表达式。 | 字符串 |
| result寿命 | 终结点调用结果的有效期,之后它不再有效。 值应遵循 ISO 8601 持续时间格式,支持语言表达式。 | 字符串 |
| roleDefinitionIds | 分配的 MSI 需要的角色定义 ID 数组才能调用终结点。 | 字符串[] |
ParameterDefinitionsValue 参数定义值
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| allowed值 | 参数的允许值。 | 任何[] |
| 默认值 | 如果未提供任何值,则为参数的默认值。 | 任何 |
| 元数据 | 参数的常规元数据。 | ParameterDefinitionsValueMetadata |
| 架构 | 使用自定义 JSON 架构在分配期间提供参数输入的验证。 此属性仅支持对象类型参数,并遵循 Json.NET Schema 2019-09 实现。 可以在 https://json-schema.org/ 了解有关在 https://www.jsonschemavalidator.net/使用架构的详细信息,并测试草稿架构。 | 任何 |
| 类型 | 参数的数据类型。 | “Array” “Boolean” “DateTime” “Float” “Integer” “Object” “String” |
ParameterDefinitionsValueMetadata
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| 分配权限 | 设置为 true,让 Azure 门户在策略分配期间基于此参数的资源 ID 或资源范围值创建角色分配。 如果要在分配范围之外分配权限,此属性非常有用。 | 布尔 |
| 描述 | 参数的说明。 | 字符串 |
| displayName (显示名称) | 参数的显示名称。 | 字符串 |
| strong类型 | 通过门户分配策略定义时使用。 提供可供用户选择的值的上下文感知列表。 | 字符串 |
PolicyDefinitionVersionProperties
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| 描述 | 策略定义说明。 | 字符串 |
| displayName (显示名称) | 策略定义的显示名称。 | 字符串 |
| externalEvaluationEnforcementSettings | 强制评估期间策略所需的外部评估结果源的详细信息。 | ExternalEvaluationEnforcementSettings (外部评估强制设置) |
| 元数据 | 策略定义元数据。 元数据是一个开放结束的对象,通常是键值对的集合。 | 任何 |
| 模式 | 策略定义模式。 一些示例包括 All、Indexed、Microsoft.KeyVault.Data。 | 字符串 |
| 参数 | 策略规则中使用的参数的参数定义。 键是参数名称。 | PolicyDefinitionVersionPropertiesParameters(策略定义VersionProperties参数) |
| policyRule 策略规则 | 策略规则。 | 任何 |
| policyType | 策略定义的类型。 可能的值为 NotSpecified、BuiltIn、Custom 和 Static。 | “BuiltIn” “Custom” “NotSpecified” “Static” |
| 版本 | #.#.# 格式的策略定义版本。 | 字符串 |
PolicyDefinitionVersionPropertiesParameters(策略定义VersionProperties参数)
| 名称 | DESCRIPTION | 价值 |
|---|
ARM 模板资源定义
可以使用目标操作部署 policyDefinitions/versions 资源类型:
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Authorization/policyDefinitions/versions 资源,请将以下 JSON 添加到模板。
{
"type": "Microsoft.Authorization/policyDefinitions/versions",
"apiVersion": "2025-03-01",
"name": "string",
"properties": {
"description": "string",
"displayName": "string",
"externalEvaluationEnforcementSettings": {
"endpointSettings": {
"details": {},
"kind": "string"
},
"missingTokenAction": "string",
"resultLifespan": "string",
"roleDefinitionIds": [ "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"
}
}
属性值
Microsoft.Authorization/policyDefinitions/versions
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| apiVersion | API 版本 | '2025-03-01' |
| 姓名 | 资源名称 | 字符串 约束: 模式 = ^\d+\.\d+\.\d+$ (必需) |
| 属性 | 策略定义版本属性。 | PolicyDefinitionVersionProperties |
| 类型 | 资源类型 | “Microsoft.Authorization/policyDefinitions/versions” |
ExternalEvaluationEndpointSettings
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| 详 | 终结点的详细信息。 | 任何 |
| 类 | 终结点的类型。 | 字符串 |
ExternalEvaluationEnforcementSettings (外部评估强制设置)
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| endpointSettings | 提供评估结果的外部终结点的设置。 | ExternalEvaluationEndpointSettings |
| missingTokenAction | 评估需要外部评估且缺少令牌的强制策略时该怎么办。 可能的值为 Audit 和 Deny,支持语言表达式。 | 字符串 |
| result寿命 | 终结点调用结果的有效期,之后它不再有效。 值应遵循 ISO 8601 持续时间格式,支持语言表达式。 | 字符串 |
| roleDefinitionIds | 分配的 MSI 需要的角色定义 ID 数组才能调用终结点。 | 字符串[] |
ParameterDefinitionsValue 参数定义值
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| allowed值 | 参数的允许值。 | 任何[] |
| 默认值 | 如果未提供任何值,则为参数的默认值。 | 任何 |
| 元数据 | 参数的常规元数据。 | ParameterDefinitionsValueMetadata |
| 架构 | 使用自定义 JSON 架构在分配期间提供参数输入的验证。 此属性仅支持对象类型参数,并遵循 Json.NET Schema 2019-09 实现。 可以在 https://json-schema.org/ 了解有关在 https://www.jsonschemavalidator.net/使用架构的详细信息,并测试草稿架构。 | 任何 |
| 类型 | 参数的数据类型。 | “Array” “Boolean” “DateTime” “Float” “Integer” “Object” “String” |
ParameterDefinitionsValueMetadata
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| 分配权限 | 设置为 true,让 Azure 门户在策略分配期间基于此参数的资源 ID 或资源范围值创建角色分配。 如果要在分配范围之外分配权限,此属性非常有用。 | 布尔 |
| 描述 | 参数的说明。 | 字符串 |
| displayName (显示名称) | 参数的显示名称。 | 字符串 |
| strong类型 | 通过门户分配策略定义时使用。 提供可供用户选择的值的上下文感知列表。 | 字符串 |
PolicyDefinitionVersionProperties
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| 描述 | 策略定义说明。 | 字符串 |
| displayName (显示名称) | 策略定义的显示名称。 | 字符串 |
| externalEvaluationEnforcementSettings | 强制评估期间策略所需的外部评估结果源的详细信息。 | ExternalEvaluationEnforcementSettings (外部评估强制设置) |
| 元数据 | 策略定义元数据。 元数据是一个开放结束的对象,通常是键值对的集合。 | 任何 |
| 模式 | 策略定义模式。 一些示例包括 All、Indexed、Microsoft.KeyVault.Data。 | 字符串 |
| 参数 | 策略规则中使用的参数的参数定义。 键是参数名称。 | PolicyDefinitionVersionPropertiesParameters(策略定义VersionProperties参数) |
| policyRule 策略规则 | 策略规则。 | 任何 |
| policyType | 策略定义的类型。 可能的值为 NotSpecified、BuiltIn、Custom 和 Static。 | “BuiltIn” “Custom” “NotSpecified” “Static” |
| 版本 | #.#.# 格式的策略定义版本。 | 字符串 |
PolicyDefinitionVersionPropertiesParameters(策略定义VersionProperties参数)
| 名称 | DESCRIPTION | 价值 |
|---|
用法示例
Terraform (AzAPI 提供程序)资源定义
可以使用目标操作部署 policyDefinitions/versions 资源类型:
- 管理组* 订阅
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Authorization/policyDefinitions/versions 资源,请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Authorization/policyDefinitions/versions@2025-03-01"
name = "string"
parent_id = "string"
body = {
properties = {
description = "string"
displayName = "string"
externalEvaluationEnforcementSettings = {
endpointSettings = {
details = ?
kind = "string"
}
missingTokenAction = "string"
resultLifespan = "string"
roleDefinitionIds = [
"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"
}
}
}
属性值
Microsoft.Authorization/policyDefinitions/versions
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| 姓名 | 资源名称 | 字符串 约束: 模式 = ^\d+\.\d+\.\d+$ (必需) |
| parent_id | 此资源的父资源的 ID。 | 类型资源的 ID:policyDefinitions |
| 属性 | 策略定义版本属性。 | PolicyDefinitionVersionProperties |
| 类型 | 资源类型 | “Microsoft.Authorization/policyDefinitions/versions@2025-03-01” |
ExternalEvaluationEndpointSettings
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| 详 | 终结点的详细信息。 | 任何 |
| 类 | 终结点的类型。 | 字符串 |
ExternalEvaluationEnforcementSettings (外部评估强制设置)
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| endpointSettings | 提供评估结果的外部终结点的设置。 | ExternalEvaluationEndpointSettings |
| missingTokenAction | 评估需要外部评估且缺少令牌的强制策略时该怎么办。 可能的值为 Audit 和 Deny,支持语言表达式。 | 字符串 |
| result寿命 | 终结点调用结果的有效期,之后它不再有效。 值应遵循 ISO 8601 持续时间格式,支持语言表达式。 | 字符串 |
| roleDefinitionIds | 分配的 MSI 需要的角色定义 ID 数组才能调用终结点。 | 字符串[] |
ParameterDefinitionsValue 参数定义值
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| allowed值 | 参数的允许值。 | 任何[] |
| 默认值 | 如果未提供任何值,则为参数的默认值。 | 任何 |
| 元数据 | 参数的常规元数据。 | ParameterDefinitionsValueMetadata |
| 架构 | 使用自定义 JSON 架构在分配期间提供参数输入的验证。 此属性仅支持对象类型参数,并遵循 Json.NET Schema 2019-09 实现。 可以在 https://json-schema.org/ 了解有关在 https://www.jsonschemavalidator.net/使用架构的详细信息,并测试草稿架构。 | 任何 |
| 类型 | 参数的数据类型。 | “Array” “Boolean” “DateTime” “Float” “Integer” “Object” “String” |
ParameterDefinitionsValueMetadata
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| 分配权限 | 设置为 true,让 Azure 门户在策略分配期间基于此参数的资源 ID 或资源范围值创建角色分配。 如果要在分配范围之外分配权限,此属性非常有用。 | 布尔 |
| 描述 | 参数的说明。 | 字符串 |
| displayName (显示名称) | 参数的显示名称。 | 字符串 |
| strong类型 | 通过门户分配策略定义时使用。 提供可供用户选择的值的上下文感知列表。 | 字符串 |
PolicyDefinitionVersionProperties
| 名称 | DESCRIPTION | 价值 |
|---|---|---|
| 描述 | 策略定义说明。 | 字符串 |
| displayName (显示名称) | 策略定义的显示名称。 | 字符串 |
| externalEvaluationEnforcementSettings | 强制评估期间策略所需的外部评估结果源的详细信息。 | ExternalEvaluationEnforcementSettings (外部评估强制设置) |
| 元数据 | 策略定义元数据。 元数据是一个开放结束的对象,通常是键值对的集合。 | 任何 |
| 模式 | 策略定义模式。 一些示例包括 All、Indexed、Microsoft.KeyVault.Data。 | 字符串 |
| 参数 | 策略规则中使用的参数的参数定义。 键是参数名称。 | PolicyDefinitionVersionPropertiesParameters(策略定义VersionProperties参数) |
| policyRule 策略规则 | 策略规则。 | 任何 |
| policyType | 策略定义的类型。 可能的值为 NotSpecified、BuiltIn、Custom 和 Static。 | “BuiltIn” “Custom” “NotSpecified” “Static” |
| 版本 | #.#.# 格式的策略定义版本。 | 字符串 |
PolicyDefinitionVersionPropertiesParameters(策略定义VersionProperties参数)
| 名称 | DESCRIPTION | 价值 |
|---|