Microsoft.Authorization policySetDefinitions

Статья
04/03/2023

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

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

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

Допустимые области развертывания для ресурса policySetDefinitions:

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

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

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

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

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

resource symbolicname 'Microsoft.Authorization/policySetDefinitions@2021-06-01' = {
  name: 'string'
  scope: resourceSymbolicName
  properties: {
    description: 'string'
    displayName: 'string'
    metadata: any()
    parameters: {}
    policyDefinitionGroups: [
      {
        additionalMetadataId: 'string'
        category: 'string'
        description: 'string'
        displayName: 'string'
        name: 'string'
      }
    ]
    policyDefinitions: [
      {
        groupNames: [
          'string'
        ]
        parameters: {}
        policyDefinitionId: 'string'
        policyDefinitionReferenceId: 'string'
      }
    ]
    policyType: 'string'
  }
}

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

policySetDefinitions

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

PolicySetDefinitionProperties

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

PolicyDefinitionGroup

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

PolicyDefinitionReference

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

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

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

Допустимые области развертывания для ресурса policySetDefinitions:

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

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

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

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

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

{
  "type": "Microsoft.Authorization/policySetDefinitions",
  "apiVersion": "2021-06-01",
  "name": "string",
  "scope": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "metadata": {},
    "parameters": {},
    "policyDefinitionGroups": [
      {
        "additionalMetadataId": "string",
        "category": "string",
        "description": "string",
        "displayName": "string",
        "name": "string"
      }
    ],
    "policyDefinitions": [
      {
        "groupNames": [ "string" ],
        "parameters": {},
        "policyDefinitionId": "string",
        "policyDefinitionReferenceId": "string"
      }
    ],
    "policyType": "string"
  }
}

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

policySetDefinitions

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

PolicySetDefinitionProperties

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

PolicyDefinitionGroup

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

PolicyDefinitionReference

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

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

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

Допустимые области развертывания для ресурса policySetDefinitions:

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Authorization/policySetDefinitions@2021-06-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      parameters = {}
      policyDefinitionGroups = [
        {
          additionalMetadataId = "string"
          category = "string"
          description = "string"
          displayName = "string"
          name = "string"
        }
      ]
      policyDefinitions = [
        {
          groupNames = [
            "string"
          ]
          parameters = {}
          policyDefinitionId = "string"
          policyDefinitionReferenceId = "string"
        }
      ]
      policyType = "string"
    }
  })
}

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

policySetDefinitions

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

PolicySetDefinitionProperties

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

PolicyDefinitionGroup

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

PolicyDefinitionReference

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

Microsoft.Authorization policySetDefinitions

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

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

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

policySetDefinitions

PolicySetDefinitionProperties

PolicyDefinitionGroup

PolicyDefinitionReference

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

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

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

policySetDefinitions

PolicySetDefinitionProperties

PolicyDefinitionGroup

PolicyDefinitionReference

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

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

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

policySetDefinitions

PolicySetDefinitionProperties

PolicyDefinitionGroup

PolicyDefinitionReference

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

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

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