Microsoft.Authorization policySetDefinitions

Статья
05/09/2024

Определение ресурса Bicep

Тип ресурса policySetDefinitions является ресурсом расширения, что означает, что его можно применить к другому ресурсу.

scope Используйте свойство этого ресурса, чтобы задать область для этого ресурса. См. раздел Настройка область для ресурсов расширения в Bicep.

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

Группы управления — см. статью Команды развертывания группы управления.
Подписки — см. команды развертывания подписки.

Вы можете ссылаться на этот тип ресурса как ресурс только для чтения на уровне : Tenants

Список измененных свойств в каждой версии 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, имя ресурса Допустимые символы: Отображаемое имя может содержать любые символы. Имя ресурса не может использовать: `<>*%&:\?.+/` или управляющие символы. Не может заканчиваться точкой или пробелом.
область	Используйте при создании ресурса расширения на область, отличном от область развертывания.	Целевой ресурс Для Bicep задайте для этого свойства символьное имя ресурса, чтобы применить ресурс расширения.
properties	Свойства определения набора политик.	PolicySetDefinitionProperties

PolicySetDefinitionProperties

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

ParameterDefinitions

Имя	Описание	Значение
{настроенное свойство}		ParameterDefinitionsValue

ParameterDefinitionsValue

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

ParameterDefinitionsValueMetadata

Имя	Описание	Значение
assignPermissions	Присвойте значение true, чтобы портал Azure создавать назначения ролей по идентификатору ресурса или область значению этого параметра во время назначения политики. Это свойство полезно, если вы хотите назначить разрешения за пределами области назначения.	bool
description	Описание параметра.	строка
displayName	Отображаемое имя параметра.	строка
strongType	Используется при назначении определения политики на портале. Предоставляет контекстно-понятный список значений, которые пользователь может выбрать.	строка
{настраиваемое свойство}		Для Bicep можно использовать функцию any().

PolicyDefinitionGroup

Имя	Описание	Значение
additionalMetadataId	Идентификатор ресурса, который содержит дополнительные метаданные о группе.	строка
категория	Категория группы.	строка
description	Описание группы.	строка
displayName	Отображаемое имя группы.	строка
name	Имя группы.	string (обязательно)

PolicyDefinitionReference

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

ParameterValues

Имя	Описание	Значение
{настраиваемое свойство}		ParameterValuesValue

ParameterValuesValue

Имя	Описание	Значение
значение	Значение параметра.	Для Bicep можно использовать функцию any().

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

scope Используйте свойство этого ресурса, чтобы задать область для этого ресурса. См. раздел Настройка область ресурсов расширения в шаблонах ARM.

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

Группы управления — см. статью Команды развертывания групп управления.
Подписки — см . команды развертывания подписки.

Вы можете ссылаться на этот тип ресурса как ресурс только для чтения на уровне: Tenants

Список измененных свойств в каждой версии 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

Имя	Описание	Значение
тип	Тип ресурса	Microsoft.Authorization/policySetDefinitions
версия_API	Версия API ресурсов	'2023-04-01'
name	имя ресурса.	string (обязательно) Ограничение символов: от 1 до 128 отображаемого имени 1–64, имя ресурса Допустимые символы: Отображаемое имя может содержать любые символы. Имя ресурса не может использовать: `<>*%&:\?.+/` или управляющие символы. Не может заканчиваться точкой или пробелом.
область	Используйте при создании ресурса расширения в область, отличном от область развертывания.	Целевой ресурс Для JSON задайте полное имя ресурса, к который будет применяться ресурс расширения .
properties	Свойства определения набора политик.	PolicySetDefinitionProperties

PolicySetDefinitionProperties

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

ParameterDefinitions

Имя	Описание	Значение
{настраиваемое свойство}		ParameterDefinitionsValue

ParameterDefinitionsValue

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

ParameterDefinitionsValueMetadata

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

PolicyDefinitionGroup

Имя	Описание	Значение
additionalMetadataId	Идентификатор ресурса, который содержит дополнительные метаданные о группе.	строка
категория	Категория группы.	строка
description	Описание группы.	строка
displayName	Отображаемое имя группы.	строка
name	Имя группы.	string (обязательно)

PolicyDefinitionReference

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

ParameterValues

Имя	Описание	Значение
{настраиваемое свойство}		ParameterValuesValue

ParameterValuesValue

Имя	Описание	Значение
значение	Значение параметра.

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

parent_id Используйте свойство этого ресурса, чтобы задать область для этого ресурса.

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

Группы управления
Подписки

Вы можете ссылаться на этот тип ресурса как ресурс только для чтения на уровне: Tenants

Список измененных свойств в каждой версии 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

Имя	Описание	Значение
тип	Тип ресурса	"Microsoft.Authorization/policySetDefinitions@2023-04-01"
name	имя ресурса.	string (обязательно) Ограничение символов: от 1 до 128 отображаемого имени 1–64, имя ресурса Допустимые символы: Отображаемое имя может содержать любые символы. Имя ресурса не может использовать: `<>*%&:\?.+/` или управляющие символы. Не может заканчиваться точкой или пробелом.
parent_id	Идентификатор ресурса, к который применяется этот ресурс расширения.	string (обязательно)
properties	Свойства определения набора политик.	PolicySetDefinitionProperties

PolicySetDefinitionProperties

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

ParameterDefinitions

Имя	Описание	Значение
{настроенное свойство}		ParameterDefinitionsValue

ParameterDefinitionsValue

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

ParameterDefinitionsValueMetadata

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

PolicyDefinitionGroup

Имя	Описание	Значение
additionalMetadataId	Идентификатор ресурса, который содержит дополнительные метаданные о группе.	строка
категория	Категория группы.	строка
description	Описание группы.	строка
displayName	Отображаемое имя группы.	строка
name	Имя группы.	строка (обязательно)

PolicyDefinitionReference

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

ParameterValues

Имя	Описание	Значение
{настраиваемое свойство}		ParameterValuesValue

ParameterValuesValue

Имя	Описание	Значение
значение	Значение параметра.

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

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

Обратная связь

Дополнительные ресурсы