Политика Microsoft.AuthorizationDefinitions 2021-06-01

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

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

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

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

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

Примеры Bicep

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

targetScope = 'subscription'

param resourceName string = 'acctest0001'
param location string = 'eastus'

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: /* ERROR: Unparsed HCL syntax in LiteralNode */ {}
        }
      }
      then: {
        effect: 'audit'
      }
    }
    policyType: 'Custom'
  }
}

Примеры быстрого запуска Azure

Следующие шаблоны Azure Quickstart содержат Bicep образцов для развертывания этого типа ресурсов.

Bicep-файл Описание
Создать Диспетчер виртуальных сетей Azure и сэмплировать VNET Этот шаблон развёртает Диспетчер виртуальных сетей Azure и размещает виртуальные сети в указанную группу ресурсов. Он поддерживает несколько топологий подключения и типов членства в группах сети.
развернуть политику и назначить нескольким группам MGMT Этот шаблон — это шаблон уровня группы управления, который создаст определение политики и назначит эту политику нескольким группам управления.
Развернуть определение политики и назначить её группе управления Этот шаблон — это шаблон уровня группы управления, который создаст определение политики и назначит эту политику целевой группе управления. В настоящее время этот шаблон нельзя развернуть через портал Azure.

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

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

resource symbolicname 'Microsoft.Authorization/policyDefinitions@2021-06-01' = {
  name: 'string'
  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'
        }
        type: 'string'
      }
    }
    policyRule: any(...)
    policyType: 'string'
  }
}

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

Microsoft.Authorization/policyDefinitions

Имя Описание Ценность
имя Имя ресурса строка (обязательно)
свойства Свойства определения политики. PolicyDefinitionProperties

ParameterDefinitions

Имя Описание Ценность

ParameterDefinitionsValue

Имя Описание Ценность
допустимые значения Допустимые значения параметра. any[]
значение по умолчанию Значение по умолчанию для параметра, если значение не указано. любой
метаданные Общие метаданные параметра. ParameterDefinitionsValueMetadata
тип Тип данных параметра. Массив
Boolean'
DateTime
Float
Целое число
"Object"
"String"

ParameterDefinitionsValueMetadata

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

PolicyDefinitionProperties

Имя Описание Ценность
описание Описание определения политики. струна
отображаемое имя Отображаемое имя определения политики. струна
метаданные Метаданные определения политики. Метаданные — это открытый завершенный объект, который обычно представляет собой коллекцию пар значений ключей. любой
режим Режим определения политики. Ниже приведены примеры All, Indexed, Microsoft.KeyVault.Data. струна
Параметры Определения параметров для параметров, используемых в правиле политики. Ключи — это имена параметров. ParameterDefinitions
policyRule Правило политики. любой
policyType Тип определения политики. Возможные значения: NotSpecified, BuiltIn, Custom и Static. "BuiltIn"
"Custom"
"NotSpecified"
"Статический"

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

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

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

Шаблоны быстрого запуска Azure

Следующие Azure шаблоны быстрого запуска развёртают этот тип ресурса.

Шаблон Описание
Создать Диспетчер виртуальных сетей Azure и сэмплировать VNET

Развернуться на Azure
Этот шаблон развёртает Диспетчер виртуальных сетей Azure и размещает виртуальные сети в указанную группу ресурсов. Он поддерживает несколько топологий подключения и типов членства в группах сети.
развернуть политику и назначить нескольким группам MGMT

Развернуться на Azure
Этот шаблон — это шаблон уровня группы управления, который создаст определение политики и назначит эту политику нескольким группам управления.
Развернуть определение политики и назначить её группе управления

Развернуться на Azure
Этот шаблон — это шаблон уровня группы управления, который создаст определение политики и назначит эту политику целевой группе управления. В настоящее время этот шаблон нельзя развернуть через портал Azure.

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

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

{
  "type": "Microsoft.Authorization/policyDefinitions",
  "apiVersion": "2021-06-01",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "metadata": {},
    "mode": "string",
    "parameters": {
      "{customized property}": {
        "allowedValues": [ {} ],
        "defaultValue": {},
        "metadata": {
          "assignPermissions": "bool",
          "description": "string",
          "displayName": "string",
          "strongType": "string"
        },
        "type": "string"
      }
    },
    "policyRule": {},
    "policyType": "string"
  }
}

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

Microsoft.Authorization/policyDefinitions

Имя Описание Ценность
apiVersion Версия API '2021-06-01'
имя Имя ресурса строка (обязательно)
свойства Свойства определения политики. PolicyDefinitionProperties
тип Тип ресурса "Microsoft.Authorization/policyDefinitions"

ParameterDefinitions

Имя Описание Ценность

ParameterDefinitionsValue

Имя Описание Ценность
допустимые значения Допустимые значения параметра. any[]
значение по умолчанию Значение по умолчанию для параметра, если значение не указано. любой
метаданные Общие метаданные параметра. ParameterDefinitionsValueMetadata
тип Тип данных параметра. Массив
Boolean'
DateTime
Float
Целое число
"Object"
"String"

ParameterDefinitionsValueMetadata

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

PolicyDefinitionProperties

Имя Описание Ценность
описание Описание определения политики. струна
отображаемое имя Отображаемое имя определения политики. струна
метаданные Метаданные определения политики. Метаданные — это открытый завершенный объект, который обычно представляет собой коллекцию пар значений ключей. любой
режим Режим определения политики. Ниже приведены примеры All, Indexed, Microsoft.KeyVault.Data. струна
Параметры Определения параметров для параметров, используемых в правиле политики. Ключи — это имена параметров. ParameterDefinitions
policyRule Правило политики. любой
policyType Тип определения политики. Возможные значения: NotSpecified, BuiltIn, Custom и Static. "BuiltIn"
"Custom"
"NotSpecified"
"Статический"

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

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

  • Управленческие группы* Подписка Список изменённых свойств в каждой версии API см. журнал изменений.

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

Примеры Terraform

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

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

provider "azurerm" {
  features {
  }
}

provider "azapi" {
  skip_provider_registration = false
}

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

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

data "azurerm_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    = ["*"]
}

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Authorization/policyDefinitions@2021-06-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      description = "string"
      displayName = "string"
      metadata = ?
      mode = "string"
      parameters = {
        {customized property} = {
          allowedValues = [
            ?
          ]
          defaultValue = ?
          metadata = {
            assignPermissions = bool
            description = "string"
            displayName = "string"
            strongType = "string"
          }
          type = "string"
        }
      }
      policyRule = ?
      policyType = "string"
    }
  }
}

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

Microsoft.Authorization/policyDefinitions

Имя Описание Ценность
имя Имя ресурса строка (обязательно)
свойства Свойства определения политики. PolicyDefinitionProperties
тип Тип ресурса "Microsoft.Authorization/policyDefinitions@2021-06-01"

ParameterDefinitions

Имя Описание Ценность

ParameterDefinitionsValue

Имя Описание Ценность
допустимые значения Допустимые значения параметра. any[]
значение по умолчанию Значение по умолчанию для параметра, если значение не указано. любой
метаданные Общие метаданные параметра. ParameterDefinitionsValueMetadata
тип Тип данных параметра. Массив
Boolean'
DateTime
Float
Целое число
"Object"
"String"

ParameterDefinitionsValueMetadata

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

PolicyDefinitionProperties

Имя Описание Ценность
описание Описание определения политики. струна
отображаемое имя Отображаемое имя определения политики. струна
метаданные Метаданные определения политики. Метаданные — это открытый завершенный объект, который обычно представляет собой коллекцию пар значений ключей. любой
режим Режим определения политики. Ниже приведены примеры All, Indexed, Microsoft.KeyVault.Data. струна
Параметры Определения параметров для параметров, используемых в правиле политики. Ключи — это имена параметров. ParameterDefinitions
policyRule Правило политики. любой
policyType Тип определения политики. Возможные значения: NotSpecified, BuiltIn, Custom и Static. "BuiltIn"
"Custom"
"NotSpecified"
"Статический"