Поделиться через

Policy Assignments - Get

  • Ссылка
Служба:
Policy
Версия API:
2023-04-01

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

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

Параметры URI

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

string

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

Шаблон регулярного выражения: ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$
scope
 path True

string

Область назначения политики. Допустимые области: группа управления (формат :/providers/Microsoft.Management/managementGroups/{managementGroup}), подписка (формат '/subscriptions/{subscriptionId}'), группа ресурсов (формат :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', или ресурс (формат: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}"
api-version
 query True

string

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

string

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

Ответы

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

PolicyAssignment

ОК. Возвращает сведения о назначении политики.
Other Status Codes

CloudError

Ответ на ошибку, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: 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=2023-04-01

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

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

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=2023-04-01

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

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

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=2023-04-01

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

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

Retrieve a policy assignment with overrides

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

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

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

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

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=2023-04-01

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

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

Определения

Имя Описание
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}".

CloudError

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

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

ErrorResponse

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

createdByType

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

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

string

Key

string

ManagedIdentity

string

User

string

enforcementMode

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

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

string

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

string

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

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

string

Он переопределит тип эффекта политики.

ParameterValuesValue

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

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

object

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

PolicyAssignment

Назначение политики.

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

string

Идентификатор назначения политики.
identity

Identity

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

string

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

string

Имя назначения политики.
properties.definitionVersion

string

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

string

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

string

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

string

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

enforcementMode

Default

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

string

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

object

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

NonComplianceMessage[]

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

string[]

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

Override[]

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

<string,  ParameterValuesValue>

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

string

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

ResourceSelector[]

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

string

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

systemData

Системные метаданные, относящиеся к этому ресурсу.
type

string

Тип назначения политики.

ResourceIdentityType

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

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

string

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

string

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

string

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

ResourceSelector

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

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

string

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

Selector[]

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

Selector

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

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

string[]

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

SelectorKind

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

string[]

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

SelectorKind

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

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

string

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

string

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

string

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

string

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

systemData

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

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

string

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

string

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

createdByType

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

string

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

string

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

createdByType

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

UserAssignedIdentities

Удостоверение пользователя, связанное с политикой. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

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