通过

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

Microsoft.Authorization policyAssignments 2020-09-01

  • 项目

Bicep 资源定义

可以使用目标操作部署 policyAssignments 资源类型：

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

资源格式

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

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

属性值

身份

名字 描述 价值
类型 标识类型。 这是将系统分配的标识添加到资源时的唯一必填字段。 “None”
“SystemAssigned”

Microsoft.Authorization/policyAssignments

名字 描述 价值
身份 与策略分配关联的托管标识。 标识
位置 策略分配的位置。 仅当使用托管标识时才需要。 字符串
名字 资源名称 string （必需）
性能 策略分配的属性。 PolicyAssignmentProperties
范围 在与部署范围不同的范围内创建资源时使用。 将此属性设置为资源的符号名称，以应用 扩展资源。

NonComplianceMessage

名字 描述 价值
消息 描述资源不符合策略的原因的消息。 这会显示在“拒绝”错误消息中，以及资源的不符合符合性结果。 string （必需）
policyDefinitionReferenceId 消息适用于的策略集定义中的策略定义引用 ID。 这仅适用于策略分配分配策略集定义。 如果未提供此消息，则消息适用于此策略分配分配的所有策略。 字符串

ParameterValues

名字 描述 价值

ParameterValuesValue

名字 描述 价值
价值 参数的值。 任何

PolicyAssignmentProperties

名字 描述 价值
描述 如果发生策略冲突，此消息将是响应的一部分。 字符串
displayName 策略分配的显示名称。 字符串
enforcementMode 策略分配强制模式。 可能的值为 Default 和 DoNotEnforce。 “Default”
“DoNotEnforce”
元数据 策略分配元数据。 元数据是一个开放结束的对象，通常是键值对的集合。 任何
nonComplianceMessages 描述资源不符合策略的原因的消息。 NonComplianceMessage[]
notScopes 策略的排除范围。 string[]
参数 分配的策略规则的参数值。 键是参数名称。 ParameterValues
policyDefinitionId 要分配的策略定义或策略集定义的 ID。 字符串

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件 描述
分配内置策略以审核 VM 托管磁盘 此模板将内置策略分配给资源组范围以审核虚拟机（VM）托管磁盘。
创建 Azure 虚拟网络管理器和示例 VNET 此模板将 Azure 虚拟网络管理器和示例虚拟网络部署到命名资源组中。 它支持多个连接拓扑和网络组成员身份类型。
部署策略 def 并将其分配给多个 Mgmt 组 此模板是一个管理组级模板，用于创建策略定义并将该策略分配给多个管理组。
部署策略定义并分配给管理组 此模板是一个管理组级模板，用于创建策略定义并将该策略分配给目标管理组。 目前，无法通过 Azure 门户部署此模板。

ARM 模板资源定义

可以使用目标操作部署 policyAssignments 资源类型：

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

资源格式

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

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

属性值

身份

名字 描述 价值
类型 标识类型。 这是将系统分配的标识添加到资源时的唯一必填字段。 “None”
“SystemAssigned”

Microsoft.Authorization/policyAssignments

名字 描述 价值
apiVersion API 版本 '2020-09-01'
身份 与策略分配关联的托管标识。 标识
位置 策略分配的位置。 仅当使用托管标识时才需要。 字符串
名字 资源名称 string （必需）
性能 策略分配的属性。 PolicyAssignmentProperties
类型 资源类型 “Microsoft.Authorization/policyAssignments”

NonComplianceMessage

名字 描述 价值
消息 描述资源不符合策略的原因的消息。 这会显示在“拒绝”错误消息中，以及资源的不符合符合性结果。 string （必需）
policyDefinitionReferenceId 消息适用于的策略集定义中的策略定义引用 ID。 这仅适用于策略分配分配策略集定义。 如果未提供此消息，则消息适用于此策略分配分配的所有策略。 字符串

ParameterValues

名字 描述 价值

ParameterValuesValue

名字 描述 价值
价值 参数的值。 任何

PolicyAssignmentProperties

名字 描述 价值
描述 如果发生策略冲突，此消息将是响应的一部分。 字符串
displayName 策略分配的显示名称。 字符串
enforcementMode 策略分配强制模式。 可能的值为 Default 和 DoNotEnforce。 “Default”
“DoNotEnforce”
元数据 策略分配元数据。 元数据是一个开放结束的对象，通常是键值对的集合。 任何
nonComplianceMessages 描述资源不符合策略的原因的消息。 NonComplianceMessage[]
notScopes 策略的排除范围。 string[]
参数 分配的策略规则的参数值。 键是参数名称。 ParameterValues
policyDefinitionId 要分配的策略定义或策略集定义的 ID。 字符串

快速入门模板

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

模板 描述
将内置策略分配给现有资源组

部署到 Azure 		此模板将内置策略分配给现有资源组。
分配内置策略以审核 VM 托管磁盘

部署到 Azure 		此模板将内置策略分配给资源组范围以审核虚拟机（VM）托管磁盘。
创建 Azure 虚拟网络管理器和示例 VNET

部署到 Azure 		此模板将 Azure 虚拟网络管理器和示例虚拟网络部署到命名资源组中。 它支持多个连接拓扑和网络组成员身份类型。
部署策略 def 并将其分配给多个 Mgmt 组

部署到 Azure 		此模板是一个管理组级模板，用于创建策略定义并将该策略分配给多个管理组。
部署策略定义并分配给管理组

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

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 policyAssignments 资源类型：

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

资源格式

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

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

属性值

身份

名字 描述 价值
类型 标识类型。 这是将系统分配的标识添加到资源时的唯一必填字段。 “None”
“SystemAssigned”

Microsoft.Authorization/policyAssignments

名字 描述 价值
身份 与策略分配关联的托管标识。 标识
位置 策略分配的位置。 仅当使用托管标识时才需要。 字符串
名字 资源名称 string （必需）
parent_id 要向其应用此扩展资源的资源的 ID。 string （必需）
性能 策略分配的属性。 PolicyAssignmentProperties
类型 资源类型 “Microsoft.Authorization/policyAssignments@2020-09-01”

NonComplianceMessage

名字 描述 价值
消息 描述资源不符合策略的原因的消息。 这会显示在“拒绝”错误消息中，以及资源的不符合符合性结果。 string （必需）
policyDefinitionReferenceId 消息适用于的策略集定义中的策略定义引用 ID。 这仅适用于策略分配分配策略集定义。 如果未提供此消息，则消息适用于此策略分配分配的所有策略。 字符串

ParameterValues

名字 描述 价值

ParameterValuesValue

名字 描述 价值
价值 参数的值。 任何

PolicyAssignmentProperties

名字 描述 价值
描述 如果发生策略冲突，此消息将是响应的一部分。 字符串
displayName 策略分配的显示名称。 字符串
enforcementMode 策略分配强制模式。 可能的值为 Default 和 DoNotEnforce。 “Default”
“DoNotEnforce”
元数据 策略分配元数据。 元数据是一个开放结束的对象，通常是键值对的集合。 任何
nonComplianceMessages 描述资源不符合策略的原因的消息。 NonComplianceMessage[]
notScopes 策略的排除范围。 string[]
参数 分配的策略规则的参数值。 键是参数名称。 ParameterValues
policyDefinitionId 要分配的策略定义或策略集定义的 ID。 字符串