Policy Definitions - Create Or Update At Management Group

Служба:: Policy

Версия API:: 2025-11-01

Эта операция создаёт или обновляет определение политики в данной группе управления с именем.

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}?api-version=2025-11-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
managementGroupId	path	True	string	Идентификатор группы управления.
policyDefinitionName	path	True	string pattern: ^[^<>%&:\?.+/][^<>*%&:\?.+/ ]+$	Имя определения политики для получения.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Текст запроса

Имя	Тип	Описание
properties.description	string	Описание определения политики.
properties.displayName	string	Отображаемое имя определения политики.
properties.externalEvaluationEnforcementSettings	ExternalEvaluationEnforcementSettings	Сведения о источнике результатов внешней оценки, необходимых политике во время оценки принудительного применения.
properties.metadata		Метаданные определения политики. Метаданные — это открытый завершенный объект, который обычно представляет собой коллекцию пар значений ключей.
properties.mode	string	Режим определения политики. Ниже приведены примеры All, Indexed, Microsoft.KeyVault.Data.
properties.parameters	<string, ParameterDefinitionsValue>	Определения параметров для параметров, используемых в правиле политики. Ключи — это имена параметров.
properties.policyRule		Правило политики.
properties.policyType	PolicyType	Тип определения политики. Возможные значения: NotSpecified, BuiltIn, Custom и Static.
properties.version	string	Версия определения политики в формате #.#.#
properties.versions	string[]	Список доступных версий для этого определения политики.

Ответы

Имя	Тип	Описание
201 Created	PolicyDefinition	Операция создания ресурса 'PolicyDefinition' успешно выполнена
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Create or update a policy definition at management group level

Образец запроса

HTTP

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming?api-version=2025-11-01

{
  "properties": {
    "description": "Force resource names to begin with given 'prefix' and/or end with given 'suffix'",
    "displayName": "Enforce resource naming convention",
    "metadata": {
      "category": "Naming"
    },
    "mode": "All",
    "parameters": {
      "prefix": {
        "type": "String",
        "metadata": {
          "description": "Resource name prefix",
          "displayName": "Prefix"
        }
      },
      "suffix": {
        "type": "String",
        "metadata": {
          "description": "Resource name suffix",
          "displayName": "Suffix"
        }
      }
    },
    "policyRule": {
      "if": {
        "not": {
          "field": "name",
          "like": "[concat(parameters('prefix'), '*', parameters('suffix'))]"
        }
      },
      "then": {
        "effect": "deny"
      }
    }
  }
}

Пример ответа

Код состояния:: 201

{
  "name": "ResourceNaming",
  "type": "Microsoft.Authorization/policyDefinitions",
  "id": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
  "properties": {
    "description": "Force resource names to begin with 'prefix' and end with 'suffix'",
    "displayName": "Naming Convention",
    "metadata": {
      "category": "Naming"
    },
    "mode": "All",
    "parameters": {
      "prefix": {
        "type": "String",
        "metadata": {
          "description": "Resource name prefix",
          "displayName": "Prefix"
        }
      },
      "suffix": {
        "type": "String",
        "metadata": {
          "description": "Resource name suffix",
          "displayName": "Suffix"
        }
      }
    },
    "policyRule": {
      "if": {
        "not": {
          "field": "name",
          "like": "[concat(parameters('prefix'), '*', parameters('suffix'))]"
        }
      },
      "then": {
        "effect": "deny"
      }
    },
    "policyType": "Custom",
    "version": "1.2.1",
    "versions": [
      "1.2.1",
      "1.0.0"
    ]
  }
}

Определения

Имя	Описание
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
ExternalEvaluationEndpointSettings	Параметры внешней конечной точки, предоставляющие результаты оценки.
ExternalEvaluationEnforcementSettings	Сведения о источнике результатов внешней оценки, необходимых политике во время оценки принудительного применения.
ParameterDefinitionsValue	Определение параметра, который может быть предоставлен политике.
ParameterDefinitionsValueMetadata	Общие метаданные параметра.
ParameterType	Тип данных параметра.
PolicyDefinition	Определение политики.
PolicyType	Тип определения политики. Возможные значения: NotSpecified, BuiltIn, Custom и Static.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Объект

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Объект

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Объект

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

ExternalEvaluationEndpointSettings

Объект

Параметры внешней конечной точки, предоставляющие результаты оценки.

Имя	Тип	Описание
details		Сведения о конечной точке.
kind	string	Тип конечной точки.

ExternalEvaluationEnforcementSettings

Объект

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

Имя	Тип	Описание
endpointSettings	ExternalEvaluationEndpointSettings	Параметры внешней конечной точки, предоставляющие результаты оценки.
missingTokenAction	string	Что делать при оценке политики принудительного применения, требующей внешней оценки, и маркер отсутствует. Возможные значения: аудит и запрет и выражения языка поддерживаются.
resultLifespan	string	Срок действия вызова конечной точки, после которого он больше не действителен. Ожидается, что значение соответствует формату длительности ISO 8601 и выражениям языка.
roleDefinitionIds	string[]	Массив определения роли идентификаторов MSI назначения потребуется для вызова конечной точки.

ParameterDefinitionsValue

Объект

Определение параметра, который может быть предоставлен политике.

Имя	Тип	Описание
allowedValues	AllowedValues[]	Допустимые значения параметра.
defaultValue		Значение по умолчанию для параметра, если значение не указано.
metadata	ParameterDefinitionsValueMetadata	Общие метаданные параметра.
schema		Обеспечивает проверку входных данных параметров во время назначения с помощью самоопределимой схемы JSON. Это свойство поддерживается только для параметров объектного типа и следует реализации схемы Json.NET 2019-09. Вы можете просмотреть дополнительные сведения об использовании схем на сайте https://json-schema.org/ и протестировать черновые версии схем на сайте https://www.jsonschemavalidator.net/.
type	ParameterType	Тип данных параметра.

ParameterDefinitionsValueMetadata

Объект

Общие метаданные параметра.

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

ParameterType

Перечисление

Тип данных параметра.

Значение	Описание
String	Тип параметра строки.
Array	Тип параметра массива.
Object	Тип параметра объекта.
Boolean	Тип булевых параметров.
Integer	Тип параметра целого числа.
Float	Тип параметра float.
DateTime	Тип параметра дата-время.