Microsoft.Authorization/policyAssignments 2021-06-01 - Bicep, ARM template & Terraform AzAPI reference

Bicep 资源定义

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

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

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

资源组 - 请参阅资源组部署命令
订阅 - 请参阅订阅部署命令
管理组 - 请参阅管理组部署命令

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

资源格式

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

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

属性值

policyAssignments

名字	描述	价值
名字	资源名称	string （必需）字符限制：1-128 显示名称 1-64 资源名称管理组范围内的 1-24 个资源名称有效字符：显示名称可以包含任何字符。资源名称无法使用： `<>*%&:\?.+/` 或控制字符。不能以句点或空格结束。
位置	策略分配的位置。仅当使用托管标识时才需要。	字符串
范围	在与部署范围不同的范围内创建扩展资源时使用。	目标资源对于 Bicep，请将此属性设置为资源的符号名称，以应用扩展资源。
身份	与策略分配关联的托管标识。	标识
性能	策略分配的属性。	PolicyAssignmentProperties

身份

名字	描述	价值
类型	标识类型。这是将系统或用户分配的标识添加到资源时的唯一必填字段。	“None” “SystemAssigned” “UserAssigned”
userAssignedIdentities	与策略关联的用户标识。用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。	IdentityUserAssignedIdentities

IdentityUserAssignedIdentities

名字	描述	价值
{自定义属性}		UserAssignedIdentitiesValue

UserAssignedIdentitiesValue

此对象不包含在部署期间设置的任何属性。所有属性都是 ReadOnly。

PolicyAssignmentProperties

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

NonComplianceMessage

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

ParameterValues

名字	描述	价值
{自定义属性}		ParameterValuesValue

ParameterValuesValue

名字	描述	价值
价值	参数的值。	对于 Bicep，可以使用 any（）函数。

快速入门模板

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

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

ARM 模板资源定义

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

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

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

资源组 - 请参阅资源组部署命令
订阅 - 请参阅订阅部署命令
管理组 - 请参阅管理组部署命令

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

资源格式

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

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

属性值

policyAssignments

名字	描述	价值
类型	资源类型	“Microsoft.Authorization/policyAssignments”
apiVersion	资源 API 版本	'2021-06-01'
名字	资源名称	string （必需）字符限制：1-128 显示名称 1-64 资源名称管理组范围内的 1-24 个资源名称有效字符：显示名称可以包含任何字符。资源名称无法使用： `<>*%&:\?.+/` 或控制字符。不能以句点或空格结束。
位置	策略分配的位置。仅当使用托管标识时才需要。	字符串
范围	在与部署范围不同的范围内创建扩展资源时使用。	目标资源对于 JSON，请将该值设置为资源全名，以将扩展资源应用到该资源。
身份	与策略分配关联的托管标识。	标识
性能	策略分配的属性。	PolicyAssignmentProperties

身份

名字	描述	价值
类型	标识类型。这是将系统或用户分配的标识添加到资源时的唯一必填字段。	“None” “SystemAssigned” “UserAssigned”
userAssignedIdentities	与策略关联的用户标识。用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。	IdentityUserAssignedIdentities

IdentityUserAssignedIdentities

名字	描述	价值
{自定义属性}		UserAssignedIdentitiesValue

UserAssignedIdentitiesValue

此对象不包含在部署期间设置的任何属性。所有属性都是 ReadOnly。

PolicyAssignmentProperties

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

NonComplianceMessage

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

ParameterValues

名字	描述	价值
{自定义属性}		ParameterValuesValue

ParameterValuesValue

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

快速入门模板

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

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

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

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

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

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

资源组
订阅
管理组

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

资源格式

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

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

属性值

policyAssignments

名字	描述	价值
类型	资源类型	“Microsoft.Authorization/policyAssignments@2021-06-01”
名字	资源名称	string （必需）字符限制：1-128 显示名称 1-64 资源名称管理组范围内的 1-24 个资源名称有效字符：显示名称可以包含任何字符。资源名称无法使用： `<>*%&:\?.+/` 或控制字符。不能以句点或空格结束。
位置	策略分配的位置。仅当使用托管标识时才需要。	字符串
parent_id	要向其应用此扩展资源的资源的 ID。	string （必需）
身份	与策略分配关联的托管标识。	标识
性能	策略分配的属性。	PolicyAssignmentProperties

身份

名字	描述	价值
类型	标识类型。这是将系统或用户分配的标识添加到资源时的唯一必填字段。	“SystemAssigned” “UserAssigned”
identity_ids	与策略关联的用户标识。用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。	用户标识 ID 的数组。

IdentityUserAssignedIdentities

名字	描述	价值
{自定义属性}		UserAssignedIdentitiesValue

UserAssignedIdentitiesValue

此对象不包含在部署期间设置的任何属性。所有属性都是 ReadOnly。

PolicyAssignmentProperties

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

NonComplianceMessage

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

ParameterValues

名字	描述	价值
{自定义属性}		ParameterValuesValue

ParameterValuesValue

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

通过

Microsoft.Authorization policyAssignments 2021-06-01

Bicep 资源定义

资源格式

属性值

policyAssignments

身份

IdentityUserAssignedIdentities

UserAssignedIdentitiesValue

PolicyAssignmentProperties

NonComplianceMessage

ParameterValues

ParameterValuesValue

快速入门模板

ARM 模板资源定义

资源格式

属性值

policyAssignments

身份

IdentityUserAssignedIdentities

UserAssignedIdentitiesValue

PolicyAssignmentProperties

NonComplianceMessage

ParameterValues

ParameterValuesValue

快速入门模板

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

资源格式

属性值

policyAssignments

身份

IdentityUserAssignedIdentities

UserAssignedIdentitiesValue

PolicyAssignmentProperties

NonComplianceMessage

ParameterValues

ParameterValuesValue

反馈

其他资源