Поделиться через


Microsoft.Authorization policySetDefinitions 2025-11-01

Определение ресурсов Bicep

Тип ресурса policySetDefinitions можно развернуть с помощью операций, предназначенных для следующих операций:

  • групп управления . См. команды развертывания группы управления подписке . См. команды развертывания подписки

Для получения списка изменённых свойств в каждой версии API см. журнал изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.Authorization/policySetDefinitions, добавьте следующий Bicep в шаблон.

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

Значения свойств

Microsoft.Authorization/policySetDefinitions

Имя. Description Ценность
имя имя ресурса. string

Ограничения целостности:
Pattern = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ (обязательно)
свойства Свойства определения набора политик. PolicySetDefinitionProperties

ParameterDefinitionsValue

Имя. Description Ценность
допустимые значения Допустимые значения параметра. any[]
defaultValue Значение по умолчанию для параметра, если значение не указано. any
metadata Общие метаданные параметра. ParameterDefinitionsValueMetadata
schema Обеспечивает проверку входных данных параметров во время назначения с помощью самоопределимой схемы JSON. Это свойство поддерживается только для параметров типа объекта и следует реализации Json.NET schema 2019-09. Вы можете просмотреть дополнительные сведения об использовании схем на сайте https://json-schema.org/ и протестировать черновые версии схем на сайте https://www.jsonschemavalidator.net/. any
type Тип данных параметра. Массив
Boolean'
DateTime
Float
Целое число
"Object"
"String"

ParameterDefinitionsValueMetadata

Имя. Description Ценность
assignPermissions Задайте значение true, чтобы портал Azure создавал назначения ролей для идентификатора ресурса или значения области ресурса этого параметра во время назначения политики. Это свойство полезно, если вы хотите назначить разрешения за пределами области назначения. bool
описание Описание параметра. струна
отображаемое имя Отображаемое имя параметра. струна
strongType Используется при назначении определения политики через портал. Предоставляет контекстный список значений, которые пользователь выбирает. струна

ParameterValuesValue

Имя. Description Ценность
value Значение параметра. any

PolicyDefinitionGroup

Имя. Description Ценность
additionalMetadataId Идентификатор ресурса ресурса, содержащего дополнительные метаданные о группе. струна
категория Категория группы. струна
описание Описание группы. струна
отображаемое имя Отображаемое имя группы. струна
имя Имя группы. строка (обязательно)

PolicyDefinitionReference

Имя. Description Ценность
definitionVersion Версия используемого определения политики. струна
groupNames Имя групп, к которым относится ссылка на определение политики. строка[]
parameters Значения параметров для указанного правила политики. Ключи — это имена параметров. PolicyDefinitionReferenceParameters
policyDefinitionId Идентификатор определения политики или определения набора политик. строка (обязательно)
policyDefinitionReferenceId Уникальный идентификатор (в определении набора политик) для этой ссылки на определение политики. струна

PolicyDefinitionReferenceParameters

Имя. Description Ценность

PolicySetDefinitionProperties

Имя. Description Ценность
описание Описание определения набора политик. струна
отображаемое имя Отображаемое имя определения набора политик. струна
metadata Метаданные определения набора политик. Метаданные — это открытый завершенный объект, который обычно представляет собой коллекцию пар значений ключей. any
parameters Параметры определения набора политик, которые можно использовать в ссылках на определения политики. PolicySetDefinitionPropertiesParameters
policyDefinitionGroups Метаданные, описывающие группы ссылок на определения политики в определении набора политик. PolicyDefinitionGroup[]
policyDefinitions Массив ссылок на определения политики. PolicyDefinitionReference[] (обязательно)
policyType Тип определения набора политик. Возможные значения: NotSpecified, BuiltIn, Custom и Static. "BuiltIn"
"Custom"
"NotSpecified"
"Статический"
version Версия определения набора политик в формате #.#.# струна
Версии Список доступных версий для определения этого набора политик. строка[]

PolicySetDefinitionPropertiesParameters

Имя. Description Ценность

Примеры использования

Примеры Bicep

Простой пример развертывания определения набора политик.

targetScope = 'subscription'

param resourceName string = 'acctest0001'

resource policyDefinition 'Microsoft.Authorization/policyDefinitions@2021-06-01' = {
  name: resourceName
  properties: {
    description: ''
    displayName: 'my-policy-definition'
    mode: 'All'
    parameters: {
      allowedLocations: {
        metadata: {
          description: 'The list of allowed locations for resources.'
          displayName: 'Allowed locations'
          strongType: 'location'
        }
        type: 'Array'
      }
    }
    policyRule: {
      if: {
        not: {
          field: 'location'
          in: '[parameters(\'allowedLocations\')]'
        }
      }
      then: {
        effect: 'audit'
      }
    }
    policyType: 'Custom'
  }
}

resource policySetDefinition 'Microsoft.Authorization/policySetDefinitions@2025-01-01' = {
  name: 'acctestpolset-${resourceName}'
  properties: {
    description: ''
    displayName: 'acctestpolset-acctest0001'
    parameters: {
      allowedLocations: {
        metadata: {
          description: 'The list of allowed locations for resources.'
          displayName: 'Allowed locations'
          strongType: 'location'
        }
        type: 'Array'
      }
    }
    policyDefinitions: [
      {
        groupNames: []
        parameters: {
          listOfAllowedLocations: {
            value: '[parameters(\'allowedLocations\')]'
          }
        }
        policyDefinitionId: policyDefinition.id
        policyDefinitionReferenceId: ''
      }
    ]
    policyType: 'Custom'
  }
}

Определение ресурса ARM-шаблона

Тип ресурса policySetDefinitions можно развернуть с помощью операций, предназначенных для следующих операций:

  • групп управления . См. команды развертывания группы управления подписке . См. команды развертывания подписки

Для получения списка изменённых свойств в каждой версии API см. журнал изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.Authorization/policySetDefinitions, добавьте следующий код JSON в шаблон.

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

Значения свойств

Microsoft.Authorization/policySetDefinitions

Имя. Description Ценность
apiVersion Версия API '2025-11-01'
имя имя ресурса. string

Ограничения целостности:
Pattern = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ (обязательно)
свойства Свойства определения набора политик. PolicySetDefinitionProperties
type Тип ресурса "Microsoft.Authorization/policySetDefinitions"

ParameterDefinitionsValue

Имя. Description Ценность
допустимые значения Допустимые значения параметра. any[]
defaultValue Значение по умолчанию для параметра, если значение не указано. any
metadata Общие метаданные параметра. ParameterDefinitionsValueMetadata
schema Обеспечивает проверку входных данных параметров во время назначения с помощью самоопределимой схемы JSON. Это свойство поддерживается только для параметров типа объекта и следует реализации Json.NET schema 2019-09. Вы можете просмотреть дополнительные сведения об использовании схем на сайте https://json-schema.org/ и протестировать черновые версии схем на сайте https://www.jsonschemavalidator.net/. any
type Тип данных параметра. Массив
Boolean'
DateTime
Float
Целое число
"Object"
"String"

ParameterDefinitionsValueMetadata

Имя. Description Ценность
assignPermissions Задайте значение true, чтобы портал Azure создавал назначения ролей для идентификатора ресурса или значения области ресурса этого параметра во время назначения политики. Это свойство полезно, если вы хотите назначить разрешения за пределами области назначения. bool
описание Описание параметра. струна
отображаемое имя Отображаемое имя параметра. струна
strongType Используется при назначении определения политики через портал. Предоставляет контекстный список значений, которые пользователь выбирает. струна

ParameterValuesValue

Имя. Description Ценность
value Значение параметра. any

PolicyDefinitionGroup

Имя. Description Ценность
additionalMetadataId Идентификатор ресурса ресурса, содержащего дополнительные метаданные о группе. струна
категория Категория группы. струна
описание Описание группы. струна
отображаемое имя Отображаемое имя группы. струна
имя Имя группы. строка (обязательно)

PolicyDefinitionReference

Имя. Description Ценность
definitionVersion Версия используемого определения политики. струна
groupNames Имя групп, к которым относится ссылка на определение политики. строка[]
parameters Значения параметров для указанного правила политики. Ключи — это имена параметров. PolicyDefinitionReferenceParameters
policyDefinitionId Идентификатор определения политики или определения набора политик. строка (обязательно)
policyDefinitionReferenceId Уникальный идентификатор (в определении набора политик) для этой ссылки на определение политики. струна

PolicyDefinitionReferenceParameters

Имя. Description Ценность

PolicySetDefinitionProperties

Имя. Description Ценность
описание Описание определения набора политик. струна
отображаемое имя Отображаемое имя определения набора политик. струна
metadata Метаданные определения набора политик. Метаданные — это открытый завершенный объект, который обычно представляет собой коллекцию пар значений ключей. any
parameters Параметры определения набора политик, которые можно использовать в ссылках на определения политики. PolicySetDefinitionPropertiesParameters
policyDefinitionGroups Метаданные, описывающие группы ссылок на определения политики в определении набора политик. PolicyDefinitionGroup[]
policyDefinitions Массив ссылок на определения политики. PolicyDefinitionReference[] (обязательно)
policyType Тип определения набора политик. Возможные значения: NotSpecified, BuiltIn, Custom и Static. "BuiltIn"
"Custom"
"NotSpecified"
"Статический"
version Версия определения набора политик в формате #.#.# струна
Версии Список доступных версий для определения этого набора политик. строка[]

PolicySetDefinitionPropertiesParameters

Имя. Description Ценность

Примеры использования

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса policySetDefinitions можно развернуть с помощью операций, предназначенных для следующих операций:

  • группы управления* подписки

Для получения списка изменённых свойств в каждой версии API см. журнал изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.Authorization/policySetDefinitions, добавьте следующий объект Terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Authorization/policySetDefinitions@2025-11-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      description = "string"
      displayName = "string"
      metadata = ?
      parameters = {
        {customized property} = {
          allowedValues = [
            ?
          ]
          defaultValue = ?
          metadata = {
            assignPermissions = bool
            description = "string"
            displayName = "string"
            strongType = "string"
          }
          schema = ?
          type = "string"
        }
      }
      policyDefinitionGroups = [
        {
          additionalMetadataId = "string"
          category = "string"
          description = "string"
          displayName = "string"
          name = "string"
        }
      ]
      policyDefinitions = [
        {
          definitionVersion = "string"
          groupNames = [
            "string"
          ]
          parameters = {
            {customized property} = {
              value = ?
            }
          }
          policyDefinitionId = "string"
          policyDefinitionReferenceId = "string"
        }
      ]
      policyType = "string"
      version = "string"
      versions = [
        "string"
      ]
    }
  }
}

Значения свойств

Microsoft.Authorization/policySetDefinitions

Имя. Description Ценность
имя имя ресурса. string

Ограничения целостности:
Pattern = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ (обязательно)
свойства Свойства определения набора политик. PolicySetDefinitionProperties
type Тип ресурса "Microsoft.Authorization/policySetDefinitions@2025-11-01"

ParameterDefinitionsValue

Имя. Description Ценность
допустимые значения Допустимые значения параметра. any[]
defaultValue Значение по умолчанию для параметра, если значение не указано. any
metadata Общие метаданные параметра. ParameterDefinitionsValueMetadata
schema Обеспечивает проверку входных данных параметров во время назначения с помощью самоопределимой схемы JSON. Это свойство поддерживается только для параметров типа объекта и следует реализации Json.NET schema 2019-09. Вы можете просмотреть дополнительные сведения об использовании схем на сайте https://json-schema.org/ и протестировать черновые версии схем на сайте https://www.jsonschemavalidator.net/. any
type Тип данных параметра. Массив
Boolean'
DateTime
Float
Целое число
"Object"
"String"

ParameterDefinitionsValueMetadata

Имя. Description Ценность
assignPermissions Задайте значение true, чтобы портал Azure создавал назначения ролей для идентификатора ресурса или значения области ресурса этого параметра во время назначения политики. Это свойство полезно, если вы хотите назначить разрешения за пределами области назначения. bool
описание Описание параметра. струна
отображаемое имя Отображаемое имя параметра. струна
strongType Используется при назначении определения политики через портал. Предоставляет контекстный список значений, которые пользователь выбирает. струна

ParameterValuesValue

Имя. Description Ценность
value Значение параметра. any

PolicyDefinitionGroup

Имя. Description Ценность
additionalMetadataId Идентификатор ресурса ресурса, содержащего дополнительные метаданные о группе. струна
категория Категория группы. струна
описание Описание группы. струна
отображаемое имя Отображаемое имя группы. струна
имя Имя группы. строка (обязательно)

PolicyDefinitionReference

Имя. Description Ценность
definitionVersion Версия используемого определения политики. струна
groupNames Имя групп, к которым относится ссылка на определение политики. строка[]
parameters Значения параметров для указанного правила политики. Ключи — это имена параметров. PolicyDefinitionReferenceParameters
policyDefinitionId Идентификатор определения политики или определения набора политик. строка (обязательно)
policyDefinitionReferenceId Уникальный идентификатор (в определении набора политик) для этой ссылки на определение политики. струна

PolicyDefinitionReferenceParameters

Имя. Description Ценность

PolicySetDefinitionProperties

Имя. Description Ценность
описание Описание определения набора политик. струна
отображаемое имя Отображаемое имя определения набора политик. струна
metadata Метаданные определения набора политик. Метаданные — это открытый завершенный объект, который обычно представляет собой коллекцию пар значений ключей. any
parameters Параметры определения набора политик, которые можно использовать в ссылках на определения политики. PolicySetDefinitionPropertiesParameters
policyDefinitionGroups Метаданные, описывающие группы ссылок на определения политики в определении набора политик. PolicyDefinitionGroup[]
policyDefinitions Массив ссылок на определения политики. PolicyDefinitionReference[] (обязательно)
policyType Тип определения набора политик. Возможные значения: NotSpecified, BuiltIn, Custom и Static. "BuiltIn"
"Custom"
"NotSpecified"
"Статический"
version Версия определения набора политик в формате #.#.# струна
Версии Список доступных версий для определения этого набора политик. строка[]

PolicySetDefinitionPropertiesParameters

Имя. Description Ценность

Примеры использования

Примеры Terraform

Простой пример развертывания определения набора политик.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westus"
}

data "azapi_client_config" "current" {}

resource "azapi_resource" "policyDefinition" {
  type      = "Microsoft.Authorization/policyDefinitions@2021-06-01"
  parent_id = "/subscriptions/${data.azurerm_client_config.current.subscription_id}"
  name      = var.resource_name
  body = {
    properties = {
      description = ""
      displayName = "my-policy-definition"
      mode        = "All"
      parameters = {
        allowedLocations = {
          metadata = {
            description = "The list of allowed locations for resources."
            displayName = "Allowed locations"
            strongType  = "location"
          }
          type = "Array"
        }
      }
      policyRule = {
        if = {
          not = {
            field = "location"
            in    = "[parameters('allowedLocations')]"
          }
        }
        then = {
          effect = "audit"
        }
      }
      policyType = "Custom"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "policySetDefinition" {
  type      = "Microsoft.Authorization/policySetDefinitions@2025-01-01"
  parent_id = "/subscriptions/${data.azapi_client_config.current.subscription_id}"
  name      = "acctestpolset-${var.resource_name}"
  body = {
    properties = {
      description = ""
      displayName = "acctestpolset-${var.resource_name}"
      parameters = {
        allowedLocations = {
          metadata = {
            description = "The list of allowed locations for resources."
            displayName = "Allowed locations"
            strongType  = "location"
          }
          type = "Array"
        }
      }
      policyDefinitions = [{
        groupNames = []
        parameters = {
          listOfAllowedLocations = {
            value = "[parameters('allowedLocations')]"
          }
        }
        policyDefinitionId          = azapi_resource.policyDefinition.id
        policyDefinitionReferenceId = ""
      }]
      policyType = "Custom"
    }
  }
}