Policy Assignments - Create By Id

Служба:: Policy

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

Создает или обновляет назначение политики.
Эта операция создаёт или обновляет присвоение политики с указанным идентификатором. Политики, выполненные в рамках определённой сферы, применяются ко всем ресурсам, входящим в эту сферу. Например, когда вы назначаете политику группе ресурсов, эта политика применяется ко всем ресурсам в группе. Идентификаторы назначения политик имеют следующий формат: '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. Допустимые сферы применения: группа управления (формат: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), подписка (формат: '/subscriptions/{subscriptionId}'), группа ресурсов (формат: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' или ресурс (формат: '/subscriptions/{subscriptionId}/resourceGroupGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'.

PUT https://management.azure.com/{policyAssignmentId}?api-version=2025-01-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
policyAssignmentId	path	True	string	ID назначения политики для создания. Используйте формат "{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}".
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

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

Имя	Тип	Описание
identity	Identity	Управляемое удостоверение, связанное с назначением политики.
location	string	Расположение назначения политики. Требуется только при использовании управляемого удостоверения.
properties.assignmentType	assignmentType	Тип назначения политики. Возможные значения: NotSpecified, System, SystemHidden и Custom. Неизменяемый.
properties.definitionVersion	string	Версия используемого определения политики.
properties.description	string	Это сообщение будет частью ответа в случае нарушения политики.
properties.displayName	string	Отображаемое имя назначения политики.
properties.enforcementMode	enforcementMode	Режим принудительного применения назначений политик. Возможные значения: Default, DoNotEnforce и Регистрация
properties.metadata	object	Метаданные назначения политики. Метаданные — это открытый завершенный объект, который обычно представляет собой коллекцию пар значений ключей.
properties.nonComplianceMessages	NonComplianceMessage[]	Сообщения, описывающие, почему ресурс не соответствует политике.
properties.notScopes	string[]	Исключенные области политики.
properties.overrides	Override[]	Переопределение значения свойства политики.
properties.parameters	<string, ParameterValuesValue>	Значения параметров для назначенного правила политики. Ключи — это имена параметров.
properties.policyDefinitionId	string	Идентификатор присваиваемого определения или набора политик.
properties.resourceSelectors	ResourceSelector[]	Список селекторов ресурсов для фильтрации политик по свойствам ресурсов.

Ответы

Имя	Тип	Описание
201 Created	PolicyAssignment	Создано — возвращает информацию о назначении полиса.
Other Status Codes	CloudError	Ответ на ошибку, описывающий причину сбоя операции.

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

azure_auth

Azure Active Directory OAuth2 Flow.

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

Области

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

Примеры

Create or update policy assignment by ID

Create or update policy assignment with a managed identity by ID

Create or update policy assignment by ID

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

HTTP

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

{
  "properties": {
    "displayName": "Enforce storage account SKU",
    "description": "Allow only storage accounts of SKU Standard_GRS or Standard_LRS to be created",
    "metadata": {
      "assignedBy": "Cheapskate Boss"
    },
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
    "definitionVersion": "1.*.*",
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default"
  }
}

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

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

{
  "properties": {
    "displayName": "Enforce storage account SKU",
    "description": "Allow only storage accounts of SKU Standard_GRS or Standard_LRS to be created",
    "metadata": {
      "assignedBy": "Cheapskate Boss"
    },
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default",
    "instanceId": "b7e0f8a9-1c2d-4e3f-8b4c-5d6e7f8a9b0c"
  },
  "id": "/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "LowCostStorage"
}

Create or update policy assignment with a managed identity by ID

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

HTTP

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

{
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "eastus",
  "properties": {
    "displayName": "Enforce storage account SKU",
    "description": "Allow only storage accounts of SKU Standard_GRS or Standard_LRS to be created",
    "metadata": {
      "assignedBy": "Cheapskate Boss"
    },
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
    "definitionVersion": "1.*.*",
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default"
  }
}

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

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

{
  "properties": {
    "displayName": "Enforce storage account SKU",
    "description": "Allow only storage accounts of SKU Standard_GRS or Standard_LRS to be created",
    "metadata": {
      "assignedBy": "Cheapskate Boss"
    },
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default",
    "instanceId": "b7e0f8a9-1c2d-4e3f-8b4c-5d6e7f8a9b0c"
  },
  "identity": {
    "type": "SystemAssigned",
    "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
    "tenantId": "4bee2b8a-1bee-47c2-90e9-404241551135"
  },
  "location": "eastus",
  "id": "/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "LowCostStorage"
}

Определения

Имя	Описание
assignmentType	Тип назначения политики. Возможные значения: NotSpecified, System, SystemHidden и Custom. Неизменяемый.
CloudError	Ответ на ошибку из операции политики.
createdByType	Тип удостоверения, создавшего ресурс.
enforcementMode	Режим принудительного применения назначений политик. Возможные значения: Default, DoNotEnforce и Регистрация
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorResponse	Ответ на ошибку
Identity	Удостоверение ресурса. Назначение политики поддерживают максимум одну идентичность. Это либо системная идентификация, либо единственная пользовательская идентичность.
NonComplianceMessage	Сообщение, описывающее, почему ресурс не соответствует политике. Это отображается в сообщениях об ошибках "запрет" и в результатах соответствия требованиям ресурса.
Override	Переопределение значения свойства политики.
OverrideKind	Тип переопределения.
ParameterValuesValue	Значение параметра.
PolicyAssignment	Задание по политике.
ResourceIdentityType	Тип удостоверения. Это единственное обязательное поле при добавлении удостоверения, назначенного системой или пользователем, в ресурс.
ResourceSelector	Селектор ресурсов для фильтрации политик по свойствам ресурсов.
Selector	Выражение селектора.
SelectorKind	Тип селектора.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
UserAssignedIdentities	Удостоверение пользователя, связанное с политикой. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

assignmentType

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

Тип назначения политики. Возможные значения: NotSpecified, System, SystemHidden и Custom. Неизменяемый.

Значение	Описание
NotSpecified
System
SystemHidden
Custom

CloudError

Объект

Ответ на ошибку из операции политики.

Имя	Тип	Описание
error	ErrorResponse	Ответ на ошибку Обычный ответ на ошибку для всех API Azure Resource Manager для возврата деталей ошибок при неудачных операциях. (Это также следует формату ответа на ошибку OData.)

createdByType

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

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

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

enforcementMode

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

Режим принудительного применения назначений политик. Возможные значения: Default, DoNotEnforce и Регистрация

Значение	Описание
Default	Этот эффект политики применяется при создании или обновлении ресурса.
DoNotEnforce	Эффект политики не применяется при создании или обновлении ресурсов.
Enroll	Эффект политики не применяется при создании или обновлении ресурса, пока ресурс или область ресурса не будут зарегистрированы в экземпляр присвоения. Регистрация происходит при внедрении ресурса для регистрации в политике.

ErrorAdditionalInfo

Объект

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

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

ErrorResponse

Объект

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

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

Identity

Объект

Удостоверение ресурса. Назначение политики поддерживают максимум одну идентичность. Это либо системная идентификация, либо единственная пользовательская идентичность.

Имя	Тип	Описание
principalId	string	Главный идентификатор идентификатора ресурса. Это свойство будет предоставляться только для системной идентичности
tenantId	string	Идентификатор арендатора идентичности ресурса. Это свойство будет предоставляться только для системной идентичности
type	ResourceIdentityType	Тип удостоверения. Это единственное обязательное поле при добавлении удостоверения, назначенного системой или пользователем, в ресурс.
userAssignedIdentities	UserAssignedIdentities	Удостоверение пользователя, связанное с политикой. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

NonComplianceMessage

Объект

Сообщение, описывающее, почему ресурс не соответствует политике. Это отображается в сообщениях об ошибках "запрет" и в результатах соответствия требованиям ресурса.

Имя	Тип	Описание
message	string	Сообщение, описывающее, почему ресурс не соответствует политике. Это отображается в сообщениях об ошибках "запрет" и в результатах соответствия требованиям ресурса.
policyDefinitionReferenceId	string	Идентификатор ссылки на определение политики в определении набора политик предназначен для сообщения. Это применимо только в том случае, если назначение политики назначает определение набора политик. Если это не указано, сообщение применяется ко всем политикам, назначенным этим назначением политики.

Override

Объект

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

Имя	Тип	Описание
kind	OverrideKind	Тип переопределения.
selectors	Selector[]	Список выражений селектора.
value	string	Значение для переопределения свойства политики.

OverrideKind

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

Тип переопределения.

Значение	Описание
policyEffect	Он переопределит тип эффекта полиса.
definitionVersion	Он переопределит значение свойства определения версии присвоения полиса.

ParameterValuesValue

Объект

Значение параметра.

Имя	Тип	Описание
value		Значение параметра.