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

Microsoft.Authorization policyAssignments 2020-09-01

Bicep 资源定义

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

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

policyAssignments 资源的有效部署作用域为:

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

资源格式

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

resource symbolicname 'Microsoft.Authorization/policyAssignments@2020-09-01' = {
  name: 'string'
  location: 'string'
  scope: resourceSymbolicName
  identity: {
    type: 'string'
  }
  properties: {
    description: 'string'
    displayName: 'string'
    enforcementMode: 'string'
    metadata: any()
    nonComplianceMessages: [
      {
        message: 'string'
        policyDefinitionReferenceId: 'string'
      }
    ]
    notScopes: [
      'string'
    ]
    parameters: {}
    policyDefinitionId: 'string'
  }
}

属性值

policyAssignments

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

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

1-64 资源名称

1-24 管理组范围内的资源名称

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

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

不得以句点或空格结尾。
location 策略分配的位置。 仅在使用托管标识时才需要。 字符串
scope 在不同于部署范围的范围创建扩展资源时使用 。 目标资源

对于 Bicep,请将此属性设置为要应用 扩展资源的符号名称。
标识 与策略分配关联的托管标识。 标识
properties 策略分配的属性。 PolicyAssignmentProperties

标识

名称 说明 Value
type 标识类型。 这是向资源添加系统分配的标识时的唯一必填字段。 “None”
“SystemAssigned”

PolicyAssignmentProperties

名称 说明
description 如果违反策略,此消息将成为响应的一部分。 字符串
displayName 策略分配的显示名称。 string
enforcementMode 策略分配强制模式。 可能的值为 Default 和 DoNotEnforce。 'Default'
“DoNotEnforce”
metadata 策略分配元数据。 元数据是一个开放式对象,通常是键值对的集合。 对于 Bicep,可以使用 any () 函数。
nonComplianceMessages 描述资源不符合策略的原因的消息。 NonComplianceMessage[]
notScopes 策略的排除范围。 string[]
parameters 分配的策略规则的参数值。 键是参数名称。 对象 (object)
policyDefinitionId 要分配的策略定义或策略集定义的 ID。 字符串

NonComplianceMessage

名称 说明
message 描述资源不符合策略的原因的消息。 这显示在“拒绝”错误消息和资源不符合符合性结果中。 字符串 (必需)
policyDefinitionReferenceId 消息要用于的策略集定义中的策略定义引用 ID。 仅当策略分配分配策略集定义时,这才适用。 如果未提供此项,则消息将应用于此策略分配分配的所有策略。 字符串

快速入门模板

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

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

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

部署到 Azure
此模板是管理组级别的模板,用于创建策略定义并将该策略分配给多个管理组。
将内置策略分配给现有资源组

部署到 Azure
此模板将内置策略分配给现有资源组。
创建 Azure 虚拟网络管理器和示例 VNET

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

ARM 模板资源定义

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

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

策略分配资源的有效部署范围包括:

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

资源格式

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

{
  "type": "Microsoft.Authorization/policyAssignments",
  "apiVersion": "2020-09-01",
  "name": "string",
  "location": "string",
  "scope": "string",
  "identity": {
    "type": "string"
  },
  "properties": {
    "description": "string",
    "displayName": "string",
    "enforcementMode": "string",
    "metadata": {},
    "nonComplianceMessages": [
      {
        "message": "string",
        "policyDefinitionReferenceId": "string"
      }
    ],
    "notScopes": [ "string" ],
    "parameters": {},
    "policyDefinitionId": "string"
  }
}

属性值

policyAssignments

名称 说明 Value
type 资源类型 “Microsoft.Authorization/policyAssignments”
apiVersion 资源 API 版本 '2020-09-01'
name 资源名称 字符串 (必需)

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

1-64 资源名称

1-24 管理组范围内的资源名称

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

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

不得以句点或空格结尾。
location 策略分配的位置。 仅在使用托管标识时才需要。 字符串
scope 在与部署范围不同的范围创建扩展资源时使用 。 目标资源

对于 JSON,请将值设置为要向其应用 扩展资源 的资源的全名。
标识 与策略分配关联的托管标识。 标识
properties 策略分配的属性。 PolicyAssignmentProperties

标识

名称 说明 Value
type 标识类型。 这是向资源添加系统分配的标识时唯一必需的字段。 “None”
“SystemAssigned”

PolicyAssignmentProperties

名称 说明
description 如果违反策略,此消息将成为响应的一部分。 string
displayName 策略分配的显示名称。 字符串
enforcementMode 策略分配强制模式。 可能的值为 Default 和 DoNotEnforce。 'Default'
“DoNotEnforce”
metadata 策略分配元数据。 元数据是一个开放式对象,通常是键值对的集合。
nonComplianceMessages 描述资源不符合策略的原因的消息。 NonComplianceMessage[]
notScopes 策略的已排除范围。 string[]
parameters 分配的策略规则的参数值。 键是参数名称。 对象 (object)
policyDefinitionId 要分配的策略定义或策略集定义的 ID。 字符串

NonComplianceMessage

名称 说明
message 描述资源不符合策略的原因的消息。 这显示在“拒绝”错误消息和资源不符合符合性结果中。 字符串 (必需)
policyDefinitionReferenceId 消息要用于的策略集定义中的策略定义引用 ID。 仅当策略分配分配策略集定义时,这才适用。 如果未提供此项,则消息将应用于此策略分配分配的所有策略。 字符串

快速入门模板

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

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

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

部署到 Azure
此模板是管理组级别的模板,用于创建策略定义并将该策略分配给多个管理组。
将内置策略分配给现有资源组

部署到 Azure
此模板将内置策略分配给现有资源组。
创建 Azure 虚拟网络管理器和示例 VNET

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

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

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

parent_id使用此资源上的 属性可设置此资源的范围。

策略分配资源的有效部署范围包括:

  • 资源组
  • 订阅
  • 管理组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Authorization/policyAssignments@2020-09-01"
  name = "string"
  location = "string"
  parent_id = "string"
  identity {
    type =  "SystemAssigned"
  }
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      enforcementMode = "string"
      nonComplianceMessages = [
        {
          message = "string"
          policyDefinitionReferenceId = "string"
        }
      ]
      notScopes = [
        "string"
      ]
      parameters = {}
      policyDefinitionId = "string"
    }
  })
}

属性值

policyAssignments

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

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

1-64 资源名称

1-24 管理组范围内的资源名称

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

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

不得以句点或空格结尾。
location 策略分配的位置。 仅在使用托管标识时才需要。 字符串
parent_id 要向其应用此扩展资源的资源的 ID。 字符串 (必需)
标识 与策略分配关联的托管标识。 标识
properties 策略分配的属性。 PolicyAssignmentProperties

标识

名称 说明 Value
type 标识类型。 这是向资源添加系统分配的标识时唯一必需的字段。 “SystemAssigned”

PolicyAssignmentProperties

名称 说明
description 如果违反策略,此消息将成为响应的一部分。 字符串
displayName 策略分配的显示名称。 字符串
enforcementMode 策略分配强制模式。 可能的值为 Default 和 DoNotEnforce。 “Default”
“DoNotEnforce”
metadata 策略分配元数据。 元数据是一个开放式对象,通常是键值对的集合。
nonComplianceMessages 描述资源不符合策略的原因的消息。 NonComplianceMessage[]
notScopes 策略的排除范围。 string[]
parameters 分配的策略规则的参数值。 键是参数名称。 对象 (object)
policyDefinitionId 要分配的策略定义或策略集定义的 ID。 字符串

NonComplianceMessage

名称 说明
message 描述资源不符合策略的原因的消息。 这显示在“拒绝”错误消息和资源不符合符合性结果中。 字符串 (必需)
policyDefinitionReferenceId 消息要用于的策略集定义中的策略定义引用 ID。 仅当策略分配分配策略集定义时,这才适用。 如果未提供此项,则消息将应用于此策略分配分配的所有策略。 字符串