Policy Assignments - Get

Служба:
Policy
Версия API:
2025-11-01

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

GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}?api-version=2025-11-01
С использованием необязательных параметров: 
GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}?api-version=2025-11-01&$expand={$expand}

Параметры URI

Имя В Обязательно Тип Описание
policyAssignmentName
 path True

string

pattern: ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$

Имя назначения политики для получения.
scope
 path True

string

Полностью квалифицированный идентификатор менеджера ресурсов Azure для ресурса.
api-version
 query True

string

minLength: 1

Версия API, используемая для данной операции.
$expand
 query

string

Список дополнительных свойств с разделёнными запятыми для включения в ответ. Поддерживаемые значения: 'LatestDefinitionVersion, EffectiveDefinitionVersion'.

Ответы

Имя Тип Описание
200 OK

PolicyAssignment

Операция Azure успешно завершена.
Other Status Codes

ErrorResponse

Непредвиденное сообщение об ошибке.

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

azure_auth

Azure Active Directory OAuth2 Flow.

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

Области

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

Примеры

Retrieve a policy assignment
Retrieve a policy assignment with a system assigned identity
Retrieve a policy assignment with a user assigned identity
Retrieve a policy assignment with overrides
Retrieve a policy assignment with resource selectors

Retrieve a policy assignment

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

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming?api-version=2025-11-01

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

Код состояния:
200 
{
  "name": "EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "properties": {
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "definitionVersion": "1.*.*",
    "displayName": "Enforce resource naming rules",
    "enforcementMode": "Default",
    "instanceId": "e4b0f5a6-7c8d-4e9f-8a1b-2c3d4e5f6a7b",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "notScopes": [],
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  }
}

Retrieve a policy assignment with a system assigned identity

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

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming?api-version=2025-11-01

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

Код состояния:
200 
{
  "name": "EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
    "tenantId": "4bee2b8a-1bee-47c2-90e9-404241551135"
  },
  "location": "westus",
  "properties": {
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "definitionVersion": "1.*.*",
    "displayName": "Enforce resource naming rules",
    "enforcementMode": "Default",
    "instanceId": "e4b0f5a6-7c8d-4e9f-8a1b-2c3d4e5f6a7b",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "notScopes": [],
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  }
}

Retrieve a policy assignment with a user assigned identity

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

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming?api-version=2025-11-01

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

Код состояния:
200 
{
  "name": "EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/testResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-identity": {
        "clientId": "4bee2b8a-1bee-47c2-90e9-404241551135",
        "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a"
      }
    }
  },
  "location": "westus",
  "properties": {
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "definitionVersion": "1.*.*",
    "displayName": "Enforce resource naming rules",
    "enforcementMode": "Default",
    "instanceId": "e4b0f5a6-7c8d-4e9f-8a1b-2c3d4e5f6a7b",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "notScopes": [],
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  }
}

Retrieve a policy assignment with overrides

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

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement?api-version=2025-11-01

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

Код состояния:
200 
{
  "name": "CostManagement",
  "type": "Microsoft.Authorization/policyAssignments",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement",
  "properties": {
    "description": "Limit the resource location and resource SKU",
    "definitionVersion": "1.*.*",
    "displayName": "Limit the resource location and resource SKU",
    "enforcementMode": "Default",
    "instanceId": "d2f3a4b5-c6d7-8e9f-0a1b-2c3d4e5f6a7b",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "notScopes": [],
    "overrides": [
      {
        "kind": "policyEffect",
        "selectors": [
          {
            "in": [
              "Limit_Skus",
              "Limit_Locations"
            ],
            "kind": "policyDefinitionReferenceId"
          }
        ],
        "value": "Audit"
      }
    ],
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  }
}

Retrieve a policy assignment with resource selectors

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

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement?api-version=2025-11-01

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

Код состояния:
200 
{
  "name": "CostManagement",
  "type": "Microsoft.Authorization/policyAssignments",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement",
  "properties": {
    "description": "Limit the resource location and resource SKU",
    "definitionVersion": "1.*.*",
    "displayName": "Limit the resource location and resource SKU",
    "enforcementMode": "Default",
    "instanceId": "a3c4d5e6-f7a8-9b0c-1d2e-3f4a5b6c7d8e",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "notScopes": [],
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement",
    "resourceSelectors": [
      {
        "name": "SDPRegions",
        "selectors": [
          {
            "in": [
              "eastus2euap",
              "centraluseuap"
            ],
            "kind": "resourceLocation"
          }
        ]
      }
    ],
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  }
}

Определения

Имя Описание
AssignmentType

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

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

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

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

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

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

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

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

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

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

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

Задание по политике.
ResourceIdentityType

Тип удостоверения. Это единственное обязательное поле при добавлении удостоверения, назначенного системой или пользователем, в ресурс.
ResourceSelector

Селектор ресурсов для фильтрации политик по свойствам ресурсов.
Selector

Выражение селектора.
SelectorKind

Тип селектора.
SelfServeExemptionSettings

Настройки исключения для самообслуживания для назначения полиса.
systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.
UserAssignedIdentitiesValue

AssignmentType

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

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

Значение Описание
NotSpecified

Не указанный тип присваивания.
System

Тип назначения системы.
SystemHidden

Тип скрытого назначения.
Custom

Тип индивидуального назначения.

createdByType

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

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

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

EnforcementMode

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

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

Значение Описание
Default

Этот эффект политики применяется при создании или обновлении ресурса.
DoNotEnforce

Эффект политики не применяется при создании или обновлении ресурсов.
Enroll

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

ErrorAdditionalInfo

Объект

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

Имя Тип Описание
info

object

Дополнительные сведения.
type

string

Дополнительный тип сведений.

ErrorDetail

Объект

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

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

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

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

Объект

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

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

Identity

Объект

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

Имя Тип Описание
principalId

string

Главный идентификатор идентификатора ресурса. Это свойство будет предоставляться только для системной идентичности
tenantId

string

Идентификатор арендатора идентичности ресурса. Это свойство будет предоставляться только для системной идентичности
type

ResourceIdentityType

Тип удостоверения. Это единственное обязательное поле при добавлении удостоверения, назначенного системой или пользователем, в ресурс.
userAssignedIdentities

<string,  UserAssignedIdentitiesValue>

Удостоверение пользователя, связанное с политикой. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов 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

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

PolicyAssignment

Объект

Задание по политике.

Имя Тип Default value Описание
id

string (arm-id)

Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity

Identity

Управляемое удостоверение, связанное с назначением политики.
location

string

Расположение назначения политики. Требуется только при использовании управляемого удостоверения.
name

string

Имя ресурса
properties.assignmentType

AssignmentType

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

string

Версия используемого определения политики.
properties.description

string

Это сообщение будет частью ответа в случае нарушения политики.
properties.displayName

string

Отображаемое имя назначения политики.
properties.effectiveDefinitionVersion

string

Эффективная версия используемого определения политики. Это происходит только при запросе через параметр запроса $expand.
properties.enforcementMode

EnforcementMode

Default

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

string

ID экземпляра назначения полиса. Этот идентификатор всегда меняется при удалении и создании заново.
properties.latestDefinitionVersion

string

Последняя версия определения полиса доступна. Это происходит только при запросе через параметр запроса $expand.
properties.metadata

Метаданные назначения политики. Метаданные — это открытый завершенный объект, который обычно представляет собой коллекцию пар значений ключей.
properties.nonComplianceMessages

NonComplianceMessage[]

Сообщения, описывающие, почему ресурс не соответствует политике.
properties.notScopes

string[]

Исключенные области политики.
properties.overrides

Override[]

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

<string,  ParameterValuesValue>

Значения параметров для назначенного правила политики. Ключи — это имена параметров.
properties.policyDefinitionId

string

Идентификатор присваиваемого определения или набора политик.
properties.resourceSelectors

ResourceSelector[]

Список селекторов ресурсов для фильтрации политик по свойствам ресурсов.
properties.scope

string

Область назначения политики.
properties.selfServeExemptionSettings

SelfServeExemptionSettings

Настройки исключения для самообслуживания для назначения полиса.
systemData

systemData

Azure Resource Manager метаданные, содержащие информацию createdBy и modifiedBy.
type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

ResourceIdentityType

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

Тип удостоверения. Это единственное обязательное поле при добавлении удостоверения, назначенного системой или пользователем, в ресурс.

Значение Описание
SystemAssigned

Указывает, что системная идентичность связана с ресурсом.
UserAssigned

Указывает, что системная идентичность связана с ресурсом.
None

Указывает, что с ресурсом не связана идентичность или что существующая идентичность должна быть удалена.

ResourceSelector

Объект

Селектор ресурсов для фильтрации политик по свойствам ресурсов.

Имя Тип Описание
name

string

Имя селектора ресурсов.
selectors

Selector[]

Список выражений селектора.

Selector

Объект

Выражение селектора.

Имя Тип Описание
in

string[]

Список значений для фильтрации.
kind

SelectorKind

Тип селектора.
notIn

string[]

Список значений для фильтрации.

SelectorKind

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

Тип селектора.

Значение Описание
resourceLocation

Тип селектора для фильтрации политик по расположению ресурса.
resourceType

Тип селектора для фильтрации политик по типу ресурса.
resourceWithoutLocation

Тип селектора для фильтрации политик по ресурсу без расположения.
policyDefinitionReferenceId

Тип селектора для фильтрации политик по идентификатору ссылки на определение политики.

SelfServeExemptionSettings

Объект

Настройки исключения для самообслуживания для назначения полиса.

Имя Тип Описание
enabled

boolean

Указывает, включено ли освобождение от самообслуживания.
policyDefinitionReferenceIds

string[]

В определении политики указаны идентификаторы для освобождения от самообслуживания.

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя Тип Описание
createdAt

string (date-time)

Метка времени создания ресурса (UTC).
createdBy

string

Удостоверение, создающее ресурс.
createdByType

createdByType

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

string (date-time)

Метка времени последнего изменения ресурса (UTC)
lastModifiedBy

string

Идентификатор, который последний раз изменил ресурс.
lastModifiedByType

createdByType

Тип удостоверения, который последний раз изменил ресурс.

UserAssignedIdentitiesValue

Объект
Имя Тип Описание
clientId

string

Идентификатор клиента назначаемого пользователем удостоверения.
principalId

string

Идентификатор субъекта назначаемого пользователем удостоверения.