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

Microsoft.Authorization policySetDefinitions

项目
05/09/2024

Bicep 资源定义

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

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

可以使用面向以下操作部署 policySetDefinitions 资源类型：

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

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

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

资源格式

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

resource symbolicname 'Microsoft.Authorization/policySetDefinitions@2023-04-01' = {
  name: 'string'
  scope: resourceSymbolicName
  properties: {
    description: 'string'
    displayName: 'string'
    metadata: any()
    parameters: {
      {customized property}: {
        allowedValues: [
          any
        ]
        defaultValue: any()
        metadata: {
          assignPermissions: bool
          description: 'string'
          displayName: 'string'
          strongType: 'string'
          {customized property}: any()
        }
        schema: any()
        type: 'string'
      }
    }
    policyDefinitionGroups: [
      {
        additionalMetadataId: 'string'
        category: 'string'
        description: 'string'
        displayName: 'string'
        name: 'string'
      }
    ]
    policyDefinitions: [
      {
        groupNames: [
          'string'
        ]
        parameters: {
          {customized property}: {
            value: any()
          }
        }
        policyDefinitionId: 'string'
        policyDefinitionReferenceId: 'string'
      }
    ]
    policyType: 'string'
    version: 'string'
    versions: [
      'string'
    ]
  }
}

属性值

policySetDefinitions

名称	说明	值
name	资源名称	字符串 (必需) 字符限制：1-128 显示名称 1-64 资源名称有效字符：显示名称可以包含任何字符。资源名不得包含以下内容： `<>*%&:\?.+/` 或控制字符。不得以句点或空格结尾。
scope	在不同于部署范围的范围创建扩展资源时使用。	目标资源对于 Bicep，请将此属性设置为要应用扩展资源的符号名称。
properties	策略集定义属性。	PolicySetDefinitionProperties

PolicySetDefinitionProperties

名称	说明	值
description	策略集定义说明。	字符串
displayName	策略集定义的显示名称。	字符串
metadata	策略集定义元数据。元数据是一个开放式对象，通常是键值对的集合。	对于 Bicep，可以使用任何 () 函数。
parameters	可在策略定义引用中使用的策略集定义参数。	ParameterDefinitions
policyDefinitionGroups	描述策略集定义中的策略定义引用组的元数据。	PolicyDefinitionGroup[]
policyDefinitions	策略定义引用的数组。	PolicyDefinitionReference[] (必需的)
policyType	策略集定义的类型。可能的值为 NotSpecified、BuiltIn、Custom 和 Static。	'BuiltIn' “Custom” “NotSpecified” 'Static'
版本	策略以 #.#.# 格式设置定义版本。	字符串
versions	此策略集定义的可用版本列表。	string[]

ParameterDefinitions

名称	说明	值
{customized property}		ParameterDefinitionsValue

ParameterDefinitionsValue

名称	说明	值
allowedValues	参数的允许值。	any[]
defaultValue	如果未提供任何值，则为参数的默认值。	对于 Bicep，可以使用任何 () 函数。
metadata	参数的常规元数据。	ParameterDefinitionsValueMetadata
schema	使用自定义的 JSON 架构在赋值期间提供参数输入的验证。此属性仅支持对象类型的参数，并遵循 Json.NET 架构 2019-09 实现。有关使用架构的详细信息，请参阅`https://json-schema.org/https://www.jsonschemavalidator.net/.`	对于 Bicep，可以使用任何 () 函数。
类型	参数的数据类型。	“Array” “Boolean” “DateTime” “Float” “Integer” “Object” “String”

ParameterDefinitionsValueMetadata

名称	说明	值
assignPermissions	设置为 true 以在策略分配期间Azure 门户此参数的资源 ID 或资源范围值创建角色分配。如果希望在分配范围之外分配权限，此属性会很有用。	bool
description	参数的说明。	字符串
displayName	参数的显示名称。	字符串
strongType	在通过门户分配策略定义时使用。提供上下文感知值列表供用户选择。	字符串
{customized property}		对于 Bicep，可以使用任何 () 函数。

PolicyDefinitionGroup

名称	说明	值
additionalMetadataId	包含有关组的其他元数据的资源的资源 ID。	字符串
category	组的类别。	字符串
description	组的说明。	字符串
displayName	组的显示名称。	字符串
name	组名称。	字符串 (必需)

PolicyDefinitionReference

名称	说明	值
groupNames	此策略定义引用的组的名称。	string[]
parameters	引用的策略规则的参数值。键是参数名称。	ParameterValues
policyDefinitionId	策略定义或策略集定义的 ID。	字符串 (必需)
policyDefinitionReferenceId	此策略定义引用的策略集定义) 内 (唯一 ID。	字符串

ParameterValues

名称	说明	值
{customized property}		ParameterValuesValue

ParameterValuesValue

名称	说明	值
value	参数值。	对于 Bicep，可以使用任何 () 函数。

ARM 模板资源定义

policySetDefinitions 资源类型是 扩展资源，这意味着你可以将其应用于其他资源。

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

policySetDefinitions 资源类型可以通过针对以下操作进行部署：

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

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

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

资源格式

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

{
  "type": "Microsoft.Authorization/policySetDefinitions",
  "apiVersion": "2023-04-01",
  "name": "string",
  "scope": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "metadata": {},
    "parameters": {
      "{customized property}": {
        "allowedValues": [ object ],
        "defaultValue": {},
        "metadata": {
          "assignPermissions": "bool",
          "description": "string",
          "displayName": "string",
          "strongType": "string",
          "{customized property}": {}
        },
        "schema": {},
        "type": "string"
      }
    },
    "policyDefinitionGroups": [
      {
        "additionalMetadataId": "string",
        "category": "string",
        "description": "string",
        "displayName": "string",
        "name": "string"
      }
    ],
    "policyDefinitions": [
      {
        "groupNames": [ "string" ],
        "parameters": {
          "{customized property}": {
            "value": {}
          }
        },
        "policyDefinitionId": "string",
        "policyDefinitionReferenceId": "string"
      }
    ],
    "policyType": "string",
    "version": "string",
    "versions": [ "string" ]
  }
}

属性值

policySetDefinitions

名称	说明	Value
type	资源类型	“Microsoft.Authorization/policySetDefinitions”
apiVersion	资源 API 版本	'2023-04-01'
name	资源名称	字符串 (必需) 字符限制：1-128 显示名称 1-64 资源名称有效字符：显示名称可以包含任何字符。资源名不得包含以下内容： `<>*%&:\?.+/` 或控制字符。不得以句点或空格结尾。
scope	在与部署范围不同的范围创建扩展资源时使用。	目标资源对于 JSON，请将值设置为要向其应用扩展资源的资源的全名。
properties	策略设置定义属性。	PolicySetDefinitionProperties

PolicySetDefinitionProperties

名称	说明	值
description	策略集定义说明。	字符串
displayName	策略集定义的显示名称。	字符串
metadata	策略集定义元数据。元数据是一个开放式对象，通常是键值对的集合。
parameters	策略集可在策略定义引用中使用的定义参数。	ParameterDefinitions
policyDefinitionGroups	描述策略集定义中的策略定义引用组的元数据。	PolicyDefinitionGroup[]
policyDefinitions	策略定义引用的数组。	PolicyDefinitionReference[] (必需的)
policyType	策略集定义的类型。可能的值为 NotSpecified、BuiltIn、Custom 和 Static。	“BuiltIn” “Custom” “NotSpecified” “Static”
版本	策略以 #.#.# 格式设置定义版本。	字符串
versions	此策略集定义的可用版本列表。	string[]

ParameterDefinitions

名称	说明	值
{customized property}		ParameterDefinitionsValue

ParameterDefinitionsValue

名称	说明	值
allowedValues	参数的允许值。	any[]
defaultValue	如果未提供值，则为参数的默认值。
metadata	参数的常规元数据。	ParameterDefinitionsValueMetadata
schema	使用自定义的 JSON 架构在分配期间提供参数输入的验证。此属性仅支持对象类型的参数，并遵循 Json.NET 架构 2019-09 实现。可以在以下位置了解有关使用架构 `https://json-schema.org/` 和测试草稿架构的详细信息 `https://www.jsonschemavalidator.net/.`
类型	参数的数据类型。	“Array” “Boolean” “DateTime” “Float” “Integer” “Object” “String”

ParameterDefinitionsValueMetadata

名称	说明	值
assignPermissions	设置为 true 以在策略分配期间Azure 门户此参数的资源 ID 或资源范围值创建角色分配。如果希望在分配范围之外分配权限，此属性会很有用。	bool
description	参数的说明。	字符串
displayName	参数的显示名称。	字符串
strongType	在通过门户分配策略定义时使用。提供上下文感知值列表供用户选择。	字符串
{customized property}

PolicyDefinitionGroup

名称	说明	值
additionalMetadataId	包含有关组的其他元数据的资源的资源 ID。	字符串
category	组的类别。	字符串
description	组的说明。	字符串
displayName	组的显示名称。	字符串
name	组名称。	字符串 (必需)

PolicyDefinitionReference

名称	说明	值
groupNames	此策略定义引用的组的名称。	string[]
parameters	引用的策略规则的参数值。键是参数名称。	ParameterValues
policyDefinitionId	策略定义或策略集定义的 ID。	字符串 (必需)
policyDefinitionReferenceId	此策略定义引用的策略集定义) 内 (唯一 ID。	字符串

ParameterValues

名称	说明	值
{customized property}		ParameterValuesValue

ParameterValuesValue

名称	说明	值
value	参数值。

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

policySetDefinitions 资源类型是 扩展资源，这意味着你可以将其应用于其他资源。

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

policySetDefinitions 资源类型可以通过针对以下操作进行部署：

管理组
订阅

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

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Authorization/policySetDefinitions@2023-04-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      parameters = {
        {customized property} = {
          allowedValues = [ object ]
          metadata = {
            assignPermissions = bool
            description = "string"
            displayName = "string"
            strongType = "string"
          }
          type = "string"
        }
      }
      policyDefinitionGroups = [
        {
          additionalMetadataId = "string"
          category = "string"
          description = "string"
          displayName = "string"
          name = "string"
        }
      ]
      policyDefinitions = [
        {
          groupNames = [
            "string"
          ]
          parameters = {
            {customized property} = {}
          }
          policyDefinitionId = "string"
          policyDefinitionReferenceId = "string"
        }
      ]
      policyType = "string"
      version = "string"
      versions = [
        "string"
      ]
    }
  })
}

属性值

policySetDefinitions

名称	说明	Value
type	资源类型	“Microsoft.Authorization/policySetDefinitions@2023-04-01”
name	资源名称	字符串 (必需) 字符限制：1-128 显示名称 1-64 资源名称有效字符：显示名称可以包含任何字符。资源名不得包含以下内容： `<>*%&:\?.+/` 或控制字符。不得以句点或空格结尾。
parent_id	要向其应用此扩展资源的资源的 ID。	字符串 (必需)
properties	策略设置定义属性。	PolicySetDefinitionProperties

PolicySetDefinitionProperties

名称	说明	值
description	策略集定义说明。	字符串
displayName	策略集定义的显示名称。	字符串
metadata	策略集定义元数据。元数据是一个开放式对象，通常是键值对的集合。
parameters	策略集可在策略定义引用中使用的定义参数。	ParameterDefinitions
policyDefinitionGroups	描述策略集定义中的策略定义引用组的元数据。	PolicyDefinitionGroup[]
policyDefinitions	策略定义引用的数组。	PolicyDefinitionReference[] (必需的)
policyType	策略集定义的类型。可能的值为 NotSpecified、BuiltIn、Custom 和 Static。	“BuiltIn” “Custom” “NotSpecified” “Static”
版本	策略以 #.#.# 格式设置定义版本。	字符串
versions	此策略集定义的可用版本列表。	string[]

ParameterDefinitions

名称	说明	值
{customized property}		ParameterDefinitionsValue

ParameterDefinitionsValue

名称	说明	值
allowedValues	参数的允许值。	any[]
defaultValue	如果未提供任何值，则为参数的默认值。
metadata	参数的常规元数据。	ParameterDefinitionsValueMetadata
schema	使用自定义的 JSON 架构在赋值期间提供参数输入的验证。此属性仅支持对象类型的参数，并遵循 Json.NET 架构 2019-09 实现。有关使用架构的详细信息，请参阅`https://json-schema.org/https://www.jsonschemavalidator.net/.`
类型	参数的数据类型。	“Array” “Boolean” “DateTime” “Float” “Integer” “Object” “String”

ParameterDefinitionsValueMetadata

名称	说明	值
assignPermissions	设置为 true，使Azure 门户策略分配期间对此参数的资源 ID 或资源范围值创建角色分配。如果希望在分配范围之外分配权限，此属性会很有用。	bool
description	参数的说明。	字符串
displayName	参数的显示名称。	字符串
strongType	通过门户分配策略定义时使用。提供上下文感知值列表，供用户从中进行选择。	字符串
{customized property}

PolicyDefinitionGroup

名称	说明	值
additionalMetadataId	包含有关组的其他元数据的资源的资源 ID。	字符串
category	组的类别。	字符串
description	组的说明。	字符串
displayName	组的显示名称。	字符串
name	组名称。	字符串 (必需)

PolicyDefinitionReference

名称	说明	值
groupNames	此策略定义引用所属的组的名称。	string[]
parameters	引用的策略规则的参数值。键是参数名称。	ParameterValues
policyDefinitionId	策略定义或策略集定义的 ID。	字符串 (必需)
policyDefinitionReferenceId	此策略定义引用的策略集定义) 内 (唯一 ID。	字符串

ParameterValues

名称	说明	值
{customized property}		ParameterValuesValue

ParameterValuesValue

名称	说明	值
value	参数值。

通过

Microsoft.Authorization policySetDefinitions

Bicep 资源定义

资源格式

属性值

policySetDefinitions

PolicySetDefinitionProperties

ParameterDefinitions

ParameterDefinitionsValue

ParameterDefinitionsValueMetadata

PolicyDefinitionGroup

PolicyDefinitionReference

ParameterValues

ParameterValuesValue

ARM 模板资源定义

资源格式

属性值

policySetDefinitions

PolicySetDefinitionProperties

ParameterDefinitions

ParameterDefinitionsValue

ParameterDefinitionsValueMetadata

PolicyDefinitionGroup

PolicyDefinitionReference

ParameterValues

ParameterValuesValue

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

资源格式

属性值

policySetDefinitions

PolicySetDefinitionProperties

ParameterDefinitions

ParameterDefinitionsValue

ParameterDefinitionsValueMetadata

PolicyDefinitionGroup

PolicyDefinitionReference

ParameterValues

ParameterValuesValue

反馈

其他资源