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

Microsoft.Authorization policyDefinitions 2021-06-01

  • 项目

Bicep 资源定义

policyDefinitions 资源类型是 扩展资源，这意味着你可以将其应用于另一个资源。

scope使用此资源上的 属性可设置此资源的作用域。 请参阅 在 Bicep 中设置扩展资源的范围。

policyDefinitions 资源的有效部署范围包括：

可以在以下级别将此资源类型引用为只读资源： 租户

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Authorization/policyDefinitions 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Authorization/policyDefinitions@2021-06-01' = {
  name: 'string'
  scope: resourceSymbolicName
  properties: {
    description: 'string'
    displayName: 'string'
    metadata: any()
    mode: 'string'
    parameters: {}
    policyRule: any()
    policyType: 'string'
  }
}

属性值

policyDefinitions

名称 说明 值
name 资源名称 字符串 (必需)

字符限制：1-128 显示名称

1-64 资源名称

有效字符：
显示名称可以包含任何字符。

资源名不得包含以下内容：
<>*%&:\?.+/ 或控制字符。

不得以句点或空格结尾。
scope 在不同于部署范围的范围创建扩展资源时使用 。 目标资源

对于 Bicep，请将此属性设置为要应用 扩展资源的符号名称。
properties 策略定义属性。 PolicyDefinitionProperties

PolicyDefinitionProperties

名称 说明 值
description 策略定义说明。 string
displayName 策略定义的显示名称。 字符串
metadata 策略定义元数据。 元数据是一个开放式对象，通常是键值对的集合。 对于 Bicep，可以使用 any () 函数。
mode 策略定义模式。 一些示例包括 All、Indexed、Microsoft.KeyVault.Data。 字符串
parameters 策略规则中使用的参数的参数定义。 键是参数名称。 对象 (object)
policyRule 策略规则。 对于 Bicep，可以使用 any () 函数。
policyType 策略定义的类型。 可能的值为 NotSpecified、BuiltIn、Custom 和 Static。 'BuiltIn'
“Custom”
“NotSpecified”
'Static'

快速入门模板

以下快速入门模板部署此资源类型。

模板 说明
部署策略定义并分配给管理组

部署到 Azure		 此模板是管理组级别的模板，用于创建策略定义并将该策略分配给目标管理组。 目前，无法通过 Azure 门户部署此模板。
部署 Policy Def 并分配到多个 Mgmt 组

部署到 Azure		 此模板是管理组级别的模板，用于创建策略定义并将该策略分配给多个管理组。
创建 Azure 虚拟网络管理器和示例 VNET

部署到 Azure		 此模板将 Azure 虚拟网络 Manager 和示例虚拟网络部署到命名资源组中。 它支持多种连接拓扑和网络组成员身份类型。

ARM 模板资源定义

policyDefinitions 资源类型是 扩展资源，这意味着你可以将其应用于另一个资源。

scope使用此资源上的 属性可设置此资源的作用域。 请参阅 在 ARM 模板中设置扩展资源的范围。

policyDefinitions 资源的有效部署范围包括：

可以在以下级别将此资源类型引用为只读资源： 租户

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Authorization/policyDefinitions 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Authorization/policyDefinitions",
  "apiVersion": "2021-06-01",
  "name": "string",
  "scope": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "metadata": {},
    "mode": "string",
    "parameters": {},
    "policyRule": {},
    "policyType": "string"
  }
}

属性值

policyDefinitions

名称 说明 Value
type 资源类型 'Microsoft.Authorization/policyDefinitions'
apiVersion 资源 API 版本 '2021-06-01'
name 资源名称 字符串 (必需)

字符限制：1-128 显示名称

1-64 资源名称

有效字符：
显示名称可以包含任何字符。

资源名不得包含以下内容：
<>*%&:\?.+/ 或控制字符。

不得以句点或空格结尾。
scope 在不同于部署范围的范围创建扩展资源时使用 。 目标资源

对于 JSON，请将值设置为要向其应用 扩展资源的资源 的全名。
properties 策略定义属性。 PolicyDefinitionProperties

PolicyDefinitionProperties

名称 说明 值
description 策略定义说明。 字符串
displayName 策略定义的显示名称。 字符串
metadata 策略定义元数据。 元数据是一个开放式对象，通常是键值对的集合。
mode 策略定义模式。 一些示例包括 All、Indexed、Microsoft.KeyVault.Data。 string
parameters 策略规则中使用的参数的参数定义。 键是参数名称。 对象 (object)
policyRule 策略规则。
policyType 策略定义的类型。 可能的值为 NotSpecified、BuiltIn、Custom 和 Static。 'BuiltIn'
“Custom”
“NotSpecified”
'Static'

快速入门模板

以下快速入门模板部署此资源类型。

模板 说明
部署策略定义并分配给管理组

部署到 Azure		 此模板是管理组级别的模板，用于创建策略定义并将该策略分配给目标管理组。 目前，无法通过 Azure 门户部署此模板。
部署 Policy Def 并分配到多个 Mgmt 组

部署到 Azure		 此模板是管理组级别的模板，用于创建策略定义并将该策略分配给多个管理组。
创建 Azure 虚拟网络管理器和示例 VNET

部署到 Azure		 此模板将 Azure 虚拟网络 Manager 和示例虚拟网络部署到命名资源组中。 它支持多种连接拓扑和网络组成员身份类型。

Terraform (AzAPI 提供程序) 资源定义

policyDefinitions 资源类型是 扩展资源，这意味着你可以将其应用于另一个资源。

parent_id使用此资源上的 属性可设置此资源的作用域。

policyDefinitions 资源的有效部署范围包括：

  • 管理组
  • 订阅

可以在以下级别将此资源类型引用为只读资源： 租户

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Authorization/policyDefinitions 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Authorization/policyDefinitions@2021-06-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      mode = "string"
      parameters = {}
      policyType = "string"
    }
  })
}

属性值

policyDefinitions

名称 说明 Value
type 资源类型 “Microsoft.Authorization/policyDefinitions@2021-06-01”
name 资源名称 字符串 (必需)

字符限制：1-128 显示名称

1-64 资源名称

有效字符：
显示名称可以包含任何字符。

资源名不得包含以下内容：
<>*%&:\?.+/ 或控制字符。

不得以句点或空格结尾。
parent_id 要向其应用此扩展资源的资源的 ID。 字符串 (必需)
properties 策略定义属性。 PolicyDefinitionProperties

PolicyDefinitionProperties

名称 说明 值
description 策略定义说明。 字符串
displayName 策略定义的显示名称。 string
metadata 策略定义元数据。 元数据是一个开放式对象，通常是键值对的集合。
mode 策略定义模式。 一些示例包括 All、Indexed、Microsoft.KeyVault.Data。 字符串
parameters 策略规则中使用的参数的参数定义。 键是参数名称。 对象 (object)
policyRule 策略规则。
policyType 策略定义的类型。 可能的值为 NotSpecified、BuiltIn、Custom 和 Static。 “BuiltIn”
“Custom”
“NotSpecified”
“Static”