Microsoft.Authorization policyDefinitions 2023-04-01
Определение ресурса Bicep
Тип ресурса policyDefinitions является ресурсом расширения, что означает, что его можно применить к другому ресурсу.
scope Используйте свойство этого ресурса, чтобы задать область для этого ресурса. См. раздел Настройка область для ресурсов расширения в Bicep.
Тип ресурса policyDefinitions можно развернуть с помощью операций, предназначенных для:
- Группы управления — см. статью Команды развертывания группы управления.
- Подписки — см. команды развертывания подписки.
Вы можете ссылаться на этот тип ресурса как ресурс только для чтения на уровне : Tenants
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.Authorization/policyDefinitions, добавьте в шаблон следующий код Bicep.
resource symbolicname 'Microsoft.Authorization/policyDefinitions@2023-04-01' = {
name: 'string'
scope: resourceSymbolicName
properties: {
description: 'string'
displayName: 'string'
metadata: any()
mode: 'string'
parameters: {
{customized property}: {
allowedValues: [
any
]
defaultValue: any()
metadata: {
assignPermissions: bool
description: 'string'
displayName: 'string'
strongType: 'string'
{customized property}: any()
}
schema: any()
type: 'string'
}
}
policyRule: any()
policyType: 'string'
version: 'string'
versions: [
'string'
]
}
}
Значения свойств
policyDefinitions
| Имя | Описание | Значение |
|---|---|---|
| name | имя ресурса. | строка (обязательно) Ограничение символов: от 1 до 128 отображаемых имен 1–64, имя ресурса Допустимые символы: Отображаемое имя может содержать любые символы. Имя ресурса не может использовать: <>*%&:\?+/ или управляющие символы. Не может заканчиваться точкой или пробелом. |
| область | Используйте при создании ресурса расширения на область, отличном от область развертывания. | Целевой ресурс Для Bicep задайте для этого свойства символьное имя ресурса, чтобы применить ресурс расширения. |
| properties | Свойства определения политики. | PolicyDefinitionProperties |
PolicyDefinitionProperties
| Имя | Описание | Значение |
|---|---|---|
| description | Описание определения политики. | строка |
| displayName | Отображаемое имя определения политики. | строка |
| метаданные | Метаданные определения политики. Метаданные — это открытый завершенный объект, который обычно представляет собой коллекцию пар "ключ-значение". | Для Bicep можно использовать функцию any(). |
| mode | Режим определения политики. Примеры: All, Indexed, Microsoft.KeyVault.Data. | строка |
| параметры | Определения параметров, используемых в правиле политики. Ключи — это имена параметров. | ParameterDefinitions |
| policyRule | Правило политики. | Для Bicep можно использовать функцию any(). |
| 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(). |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
Развертывание определения политики и назначение группе управления |
Этот шаблон является шаблоном уровня группы управления, который создаст определение политики и назначит эту политику целевой группе управления. В настоящее время этот шаблон нельзя развернуть на портале Azure. |
| Развертывание политики Def и назначение нескольким Группы mgmt |
Этот шаблон представляет собой шаблон уровня группы управления, который создаст определение политики и назначит эту политику нескольким группам управления. |
| Create Azure виртуальная сеть Manager и примеры виртуальных сетей |
Этот шаблон развертывает Azure виртуальная сеть Manager и примеры виртуальных сетей в именованной группе ресурсов. Он поддерживает несколько топологий подключения и типов членства в сетевых группах. |
Определение ресурса шаблона ARM
Тип ресурса policyDefinitions является ресурсом расширения, что означает, что его можно применить к другому ресурсу.
scope Используйте свойство этого ресурса, чтобы задать область для этого ресурса. См. раздел Настройка область для ресурсов расширения в шаблонах ARM.
Тип ресурса policyDefinitions можно развернуть с помощью операций, предназначенных для:
- Группы управления — см. статью Команды развертывания группы управления.
- Подписки — см. команды развертывания подписки.
Вы можете ссылаться на этот тип ресурса как ресурс только для чтения на уровне : Tenants
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.Authorization/policyDefinitions, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.Authorization/policyDefinitions",
"apiVersion": "2023-04-01",
"name": "string",
"scope": "string",
"properties": {
"description": "string",
"displayName": "string",
"metadata": {},
"mode": "string",
"parameters": {
"{customized property}": {
"allowedValues": [ object ],
"defaultValue": {},
"metadata": {
"assignPermissions": "bool",
"description": "string",
"displayName": "string",
"strongType": "string",
"{customized property}": {}
},
"schema": {},
"type": "string"
}
},
"policyRule": {},
"policyType": "string",
"version": "string",
"versions": [ "string" ]
}
}
Значения свойств
policyDefinitions
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип ресурса | Microsoft.Authorization/policyDefinitions |
| версия_API | Версия API ресурсов | '2023-04-01' |
| name | имя ресурса. | строка (обязательно) Ограничение символов: от 1 до 128 отображаемых имен 1–64, имя ресурса Допустимые символы: Отображаемое имя может содержать любые символы. Имя ресурса не может использовать: <>*%&:\?+/ или управляющие символы. Не может заканчиваться точкой или пробелом. |
| область | Используйте при создании ресурса расширения на область, отличном от область развертывания. | Целевой ресурс Для JSON задайте полное имя ресурса, к который будет применяться ресурс расширения . |
| properties | Свойства определения политики. | PolicyDefinitionProperties |
PolicyDefinitionProperties
| Имя | Описание | Значение |
|---|---|---|
| description | Описание определения политики. | строка |
| displayName | Отображаемое имя определения политики. | строка |
| метаданные | Метаданные определения политики. Метаданные — это открытый завершенный объект, который обычно представляет собой коллекцию пар "ключ-значение". | |
| mode | Режим определения политики. Примеры: All, Indexed, Microsoft.KeyVault.Data. | строка |
| параметры | Определения параметров, используемых в правиле политики. Ключи — это имена параметров. | ParameterDefinitions |
| policyRule | Правило политики. | |
| 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 | Используется при назначении определения политики через портал. Предоставляет контекстно-понятный список значений, которые пользователь может выбрать. | строка |
| {настроенное свойство} |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
| Развертывание определения политики и назначение группе управления |
Этот шаблон является шаблоном уровня группы управления, который создаст определение политики и назначит эту политику целевой группе управления. В настоящее время этот шаблон нельзя развернуть на портале Azure. |
| Развертывание политики Def и назначение нескольким Группы mgmt |
Этот шаблон представляет собой шаблон уровня группы управления, который создаст определение политики и назначит эту политику нескольким группам управления. |
| Create Azure виртуальная сеть Manager и примеры виртуальных сетей |
Этот шаблон развертывает Azure виртуальная сеть Manager и примеры виртуальных сетей в именованной группе ресурсов. Он поддерживает несколько топологий подключения и типов членства в сетевых группах. |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса policyDefinitions является ресурсом расширения, что означает, что его можно применить к другому ресурсу.
parent_id Используйте свойство этого ресурса, чтобы задать область для этого ресурса.
Тип ресурса policyDefinitions можно развернуть с помощью операций, предназначенных для:
- Группы управления
- Подписки
Вы можете ссылаться на этот тип ресурса как ресурс только для чтения на уровне : Tenants
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.Authorization/policyDefinitions, добавьте в шаблон следующую terraform.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Authorization/policyDefinitions@2023-04-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
description = "string"
displayName = "string"
mode = "string"
parameters = {
{customized property} = {
allowedValues = [ object ]
metadata = {
assignPermissions = bool
description = "string"
displayName = "string"
strongType = "string"
}
type = "string"
}
}
policyType = "string"
version = "string"
versions = [
"string"
]
}
})
}
Значения свойств
policyDefinitions
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип ресурса | "Microsoft.Authorization/policyDefinitions@2023-04-01" |
| name | имя ресурса. | string (обязательно) Ограничение символов: от 1 до 128 отображаемого имени 1–64, имя ресурса Допустимые символы: Отображаемое имя может содержать любые символы. Имя ресурса не может использовать: <>*%&:\?+/ или управляющие символы. Не может заканчиваться точкой или пробелом. |
| parent_id | Идентификатор ресурса, к который применяется этот ресурс расширения. | string (обязательно) |
| properties | Свойства определения политики. | Свойства PolicyDefinition |
Свойства PolicyDefinition
| Имя | Описание | Значение |
|---|---|---|
| description | Описание определения политики. | строка |
| displayName | Отображаемое имя определения политики. | строка |
| метаданные | Метаданные определения политики. Метаданные — это открытый завершенный объект, который обычно представляет собой коллекцию пар "ключ-значение". | |
| mode | Режим определения политики. Примеры: All, Indexed, Microsoft.KeyVault.Data. | строка |
| параметры | Определения параметров, используемых в правиле политики. Ключи — это имена параметров. | ParameterDefinitions |
| policyRule | Правило политики. | |
| 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" "Целое число" "Object" "String" |
ParameterDefinitionsValueMetadata
| Имя | Описание | Значение |
|---|---|---|
| assignPermissions | Присвойте значение true, чтобы портал Azure создавать назначения ролей по идентификатору ресурса или область значению этого параметра во время назначения политики. Это свойство полезно, если вы хотите назначить разрешения за пределами области назначения. | bool |
| description | Описание параметра. | строка |
| displayName | Отображаемое имя параметра. | строка |
| strongType | Используется при назначении определения политики через портал. Предоставляет контекстно-понятный список значений, которые пользователь может выбрать. | строка |
| {настроенное свойство} |
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по