Примечание.
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
Определение ресурсов Bicep
Тип ресурса policySetDefinitions можно развернуть с помощью операций, предназначенных для следующих операций:
- групп управления
. См. команды развертывания группы управления подписке . См. команды развертывания подписки
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.Authorization/policySetDefinitions, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.Authorization/policySetDefinitions@2020-03-01' = {
name: 'string'
properties: {
description: 'string'
displayName: 'string'
metadata: any(...)
parameters: {
{customized property}: {
allowedValues: [
any(...)
]
defaultValue: any(...)
metadata: {
description: 'string'
displayName: 'string'
}
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'
}
}
Значения свойств
Microsoft.Authorization/policySetDefinitions
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя ресурса | строка (обязательно) |
| свойства | Свойства определения политики. | PolicySetDefinitionProperties |
ParameterDefinitions
| Имя | Описание | Ценность |
|---|
ParameterDefinitionsValue
| Имя | Описание | Ценность |
|---|---|---|
| allowedValues | Допустимые значения параметра. | any[] |
| значение по умолчанию | Значение по умолчанию для параметра, если значение не указано. | любой |
| метаданные | Общие метаданные параметра. | ParameterDefinitionsValueMetadata |
| тип | Тип данных параметра. | Массив Boolean' DateTime Float Целое число "Object" "String" |
ParameterDefinitionsValueMetadata
| Имя | Описание | Ценность |
|---|---|---|
| описание | Описание параметра. | струна |
| отображаемое имя | Отображаемое имя параметра. | струна |
ParameterValues
| Имя | Описание | Ценность |
|---|
ParameterValuesValue
| Имя | Описание | Ценность |
|---|---|---|
| ценность | Значение параметра. | любой |
PolicyDefinitionGroup
| Имя | Описание | Ценность |
|---|---|---|
| additionalMetadataId | Идентификатор ресурса ресурса, содержащего дополнительные метаданные о группе. | струна |
| категория | Категория группы. | струна |
| описание | Описание группы. | струна |
| отображаемое имя | Отображаемое имя группы. | струна |
| имя | Имя группы. | строка (обязательно) |
PolicyDefinitionReference
| Имя | Описание | Ценность |
|---|---|---|
| groupNames | Имя групп, к которым относится ссылка на определение политики. | строка[] |
| Параметры | Значения параметров для указанного правила политики. Ключи — это имена параметров. | ParameterValues |
| policyDefinitionId | Идентификатор определения политики или определения набора политик. | строка (обязательно) |
| policyDefinitionReferenceId | Уникальный идентификатор (в определении набора политик) для этой ссылки на определение политики. | струна |
PolicySetDefinitionProperties
| Имя | Описание | Ценность |
|---|---|---|
| описание | Описание определения набора политик. | струна |
| отображаемое имя | Отображаемое имя определения набора политик. | струна |
| метаданные | Метаданные определения набора политик. Метаданные — это открытый завершенный объект, который обычно представляет собой коллекцию пар значений ключей. | любой |
| Параметры | Параметры определения набора политик, которые можно использовать в ссылках на определения политики. | ParameterDefinitions |
| policyDefinitionGroups | Метаданные, описывающие группы ссылок на определения политики в определении набора политик. | PolicyDefinitionGroup[] |
| policyDefinitions | Массив ссылок на определения политики. | PolicyDefinitionReference[] (обязательно) |
| policyType | Тип определения политики. Возможные значения: NotSpecified, BuiltIn, Custom и Static. | "BuiltIn" "Custom" "NotSpecified" "Статический" |
Примеры использования
Примеры 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": "2020-03-01",
"name": "string",
"properties": {
"description": "string",
"displayName": "string",
"metadata": {},
"parameters": {
"{customized property}": {
"allowedValues": [ {} ],
"defaultValue": {},
"metadata": {
"description": "string",
"displayName": "string"
},
"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"
}
}
Значения свойств
Microsoft.Authorization/policySetDefinitions
| Имя | Описание | Ценность |
|---|---|---|
| apiVersion | Версия API | '2020-03-01' |
| имя | Имя ресурса | строка (обязательно) |
| свойства | Свойства определения политики. | PolicySetDefinitionProperties |
| тип | Тип ресурса | "Microsoft.Authorization/policySetDefinitions" |
ParameterDefinitions
| Имя | Описание | Ценность |
|---|
ParameterDefinitionsValue
| Имя | Описание | Ценность |
|---|---|---|
| allowedValues | Допустимые значения параметра. | any[] |
| значение по умолчанию | Значение по умолчанию для параметра, если значение не указано. | любой |
| метаданные | Общие метаданные параметра. | ParameterDefinitionsValueMetadata |
| тип | Тип данных параметра. | Массив Boolean' DateTime Float Целое число "Object" "String" |
ParameterDefinitionsValueMetadata
| Имя | Описание | Ценность |
|---|---|---|
| описание | Описание параметра. | струна |
| отображаемое имя | Отображаемое имя параметра. | струна |
ParameterValues
| Имя | Описание | Ценность |
|---|
ParameterValuesValue
| Имя | Описание | Ценность |
|---|---|---|
| ценность | Значение параметра. | любой |
PolicyDefinitionGroup
| Имя | Описание | Ценность |
|---|---|---|
| additionalMetadataId | Идентификатор ресурса ресурса, содержащего дополнительные метаданные о группе. | струна |
| категория | Категория группы. | струна |
| описание | Описание группы. | струна |
| отображаемое имя | Отображаемое имя группы. | струна |
| имя | Имя группы. | строка (обязательно) |
PolicyDefinitionReference
| Имя | Описание | Ценность |
|---|---|---|
| groupNames | Имя групп, к которым относится ссылка на определение политики. | строка[] |
| Параметры | Значения параметров для указанного правила политики. Ключи — это имена параметров. | ParameterValues |
| policyDefinitionId | Идентификатор определения политики или определения набора политик. | строка (обязательно) |
| policyDefinitionReferenceId | Уникальный идентификатор (в определении набора политик) для этой ссылки на определение политики. | струна |
PolicySetDefinitionProperties
| Имя | Описание | Ценность |
|---|---|---|
| описание | Описание определения набора политик. | струна |
| отображаемое имя | Отображаемое имя определения набора политик. | струна |
| метаданные | Метаданные определения набора политик. Метаданные — это открытый завершенный объект, который обычно представляет собой коллекцию пар значений ключей. | любой |
| Параметры | Параметры определения набора политик, которые можно использовать в ссылках на определения политики. | ParameterDefinitions |
| policyDefinitionGroups | Метаданные, описывающие группы ссылок на определения политики в определении набора политик. | PolicyDefinitionGroup[] |
| policyDefinitions | Массив ссылок на определения политики. | PolicyDefinitionReference[] (обязательно) |
| policyType | Тип определения политики. Возможные значения: NotSpecified, BuiltIn, Custom и Static. | "BuiltIn" "Custom" "NotSpecified" "Статический" |
Примеры использования
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса policySetDefinitions можно развернуть с помощью операций, предназначенных для следующих операций:
- группы управления* подписки
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.Authorization/policySetDefinitions, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Authorization/policySetDefinitions@2020-03-01"
name = "string"
parent_id = "string"
body = {
properties = {
description = "string"
displayName = "string"
metadata = ?
parameters = {
{customized property} = {
allowedValues = [
?
]
defaultValue = ?
metadata = {
description = "string"
displayName = "string"
}
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"
}
}
}
Значения свойств
Microsoft.Authorization/policySetDefinitions
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя ресурса | строка (обязательно) |
| свойства | Свойства определения политики. | PolicySetDefinitionProperties |
| тип | Тип ресурса | "Microsoft.Authorization/policySetDefinitions@2020-03-01" |
ParameterDefinitions
| Имя | Описание | Ценность |
|---|
ParameterDefinitionsValue
| Имя | Описание | Ценность |
|---|---|---|
| allowedValues | Допустимые значения параметра. | any[] |
| значение по умолчанию | Значение по умолчанию для параметра, если значение не указано. | любой |
| метаданные | Общие метаданные параметра. | ParameterDefinitionsValueMetadata |
| тип | Тип данных параметра. | Массив Boolean' DateTime Float Целое число "Object" "String" |
ParameterDefinitionsValueMetadata
| Имя | Описание | Ценность |
|---|---|---|
| описание | Описание параметра. | струна |
| отображаемое имя | Отображаемое имя параметра. | струна |
ParameterValues
| Имя | Описание | Ценность |
|---|
ParameterValuesValue
| Имя | Описание | Ценность |
|---|---|---|
| ценность | Значение параметра. | любой |
PolicyDefinitionGroup
| Имя | Описание | Ценность |
|---|---|---|
| additionalMetadataId | Идентификатор ресурса ресурса, содержащего дополнительные метаданные о группе. | струна |
| категория | Категория группы. | струна |
| описание | Описание группы. | струна |
| отображаемое имя | Отображаемое имя группы. | струна |
| имя | Имя группы. | строка (обязательно) |
PolicyDefinitionReference
| Имя | Описание | Ценность |
|---|---|---|
| groupNames | Имя групп, к которым относится ссылка на определение политики. | строка[] |
| Параметры | Значения параметров для указанного правила политики. Ключи — это имена параметров. | ParameterValues |
| policyDefinitionId | Идентификатор определения политики или определения набора политик. | строка (обязательно) |
| policyDefinitionReferenceId | Уникальный идентификатор (в определении набора политик) для этой ссылки на определение политики. | струна |
PolicySetDefinitionProperties
| Имя | Описание | Ценность |
|---|---|---|
| описание | Описание определения набора политик. | струна |
| отображаемое имя | Отображаемое имя определения набора политик. | струна |
| метаданные | Метаданные определения набора политик. Метаданные — это открытый завершенный объект, который обычно представляет собой коллекцию пар значений ключей. | любой |
| Параметры | Параметры определения набора политик, которые можно использовать в ссылках на определения политики. | ParameterDefinitions |
| policyDefinitionGroups | Метаданные, описывающие группы ссылок на определения политики в определении набора политик. | PolicyDefinitionGroup[] |
| policyDefinitions | Массив ссылок на определения политики. | PolicyDefinitionReference[] (обязательно) |
| policyType | Тип определения политики. Возможные значения: NotSpecified, BuiltIn, Custom и Static. | "BuiltIn" "Custom" "NotSpecified" "Статический" |
Примеры использования
Примеры 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"
}
}
}