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


Policy Enrollments - List For Resource

Получает все регистрации полисов, которые применяются к ресурсу.
Эта операция получает список всех регистраций политик, связанных с указанным ресурсом в данной группе ресурсов и подписке, которые соответствуют необязательному данному $filter. Допустимые значения для $filter: 'atScope()' или 'atExactScope()'. Если $filter не предоставлено, неотфильтрованный список включает все регистрации политик, связанные с ресурсом, включая те, которые применяются напрямую или из всех содержащих областей, а также любые применяемые к ресурсам, содержащимся в ресурсе. Для идентификации определенного ресурса используются три параметра, а также имя ресурса. Если ресурс не является частью родительского ресурса (более распространенным случаем), родительский путь к ресурсу не должен быть указан (или указан как "). Например, веб-приложение можно указать как ({resourceProviderNamespace} == 'Microsoft.Web', {parentResourcePath} == '', {resourceType} == 'sites', {resourceName} == 'MyWebApp'). Если ресурс является частью родительского ресурса, необходимо предоставить все параметры. Например, DNS-имя виртуальной машины можно указать как ({resourceProviderNamespace} == 'Microsoft.Compute', {parentResourcePath} == 'virtualMachines/MyVirtualMachine', {resourceType} == 'domainNames', {resourceName} == 'MyComputerName'). Удобная альтернатива предоставлению пространства имен и имени типа отдельно заключается в том, чтобы указать оба параметра {resourceType}, формат: ({resourceProviderNamespace} == ', {parentResourcePath} == '', {resourceType} == 'Microsoft.Web/sites', {resourceName} == 'MyWebApp').

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/policyEnrollments?api-version=2026-01-01-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/policyEnrollments?api-version=2026-01-01-preview&$filter={$filter}

Параметры URI

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

string

Родительский путь к ресурсу. Используйте пустую строку, если нет.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Имя группы ресурсов. Имя регистронезависимо.

resourceName
path True

string

pattern: ^.+$

Имя ресурса.

resourceProviderNamespace
path True

string

Пространство имен поставщика ресурсов. Например, пространство имен виртуальной машины — Microsoft.Compute (из Microsoft.Compute/virtualMachines)

resourceType
path True

string

Имя типа ресурса. Например, имя типа веб-приложения — "сайты" (из Microsoft.Web/sites).

subscriptionId
path True

string (uuid)

Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).

api-version
query True

string

minLength: 1

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

$filter
query

string

Фильтр, применяемый к операции. Допустимые значения для $filter: 'atScope()' или 'atExactScope()'. Если $filter не предоставлено, фильтрация не выполняется. Если $filter не предоставлено, неотфильтрованный список включает все регистрации политик, связанных с областью применения, включая те, которые применяются напрямую или содержат область применения. Если предоставлен $filter=atScope(), возвращаемый список включает все регистрации политик, применимые к области области, то есть всё, что находится в неотфильтрованном списке, кроме тех, что применяются к подобластям, входящим в данную область видимости. Если предоставлен $filter=atExactScope(), вернутый список включает только все регистрации политик, применимые в данной области.

Ответы

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

PolicyEnrollmentListResult

Операция 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 олицетворения учетной записи пользователя

Примеры

List policy enrollments for resource

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

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup/providers/Microsoft.Compute/virtualMachines/MyTestVm/domainNames/MyTestComputer.cloudapp.net/providers/Microsoft.Authorization/policyEnrollments?api-version=2026-01-01-preview

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

{
  "value": [
    {
      "properties": {
        "policyAssignmentId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement",
        "policyDefinitionReferenceIds": [
          "Limit_Skus"
        ],
        "policyAssignmentInstanceId": "00000000-0000-0000-0000-000000000000",
        "displayName": "Enroll demo cluster",
        "description": "Enroll demo cluster from limit sku",
        "metadata": {
          "reason": "Enrollment for a expensive VM demo"
        }
      },
      "systemData": {
        "createdBy": "string",
        "createdByType": "User",
        "createdAt": "2020-07-01T01:01:01.1075056Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-07-01T02:01:01.1075056Z"
      },
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup/providers/Microsoft.Authorization/policyEnrollments/DemoExpensiveVMGroup",
      "type": "Microsoft.Authorization/policyEnrollments",
      "eTag": "00000000-0000-0000-0000-000000000000",
      "name": "DemoExpensiveVMGroup"
    },
    {
      "properties": {
        "policyAssignmentId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/LimitPorts",
        "policyAssignmentInstanceId": "00000000-0000-0000-0000-000000000000",
        "displayName": "Enroll jump box open ports",
        "description": "Enroll jump box open ports from limit ports policy",
        "metadata": {
          "reason": "Need to open RDP port to corp net"
        }
      },
      "systemData": {
        "createdBy": "string",
        "createdByType": "User",
        "createdAt": "2020-07-01T01:01:01.1075056Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-07-01T02:01:01.1075056Z"
      },
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup/providers/Microsoft.Compute/virtualMachines/MyTestVm/providers/Microsoft.Authorization/policyEnrollments/jumpBoxEnrollment",
      "type": "Microsoft.Authorization/policyEnrollments",
      "eTag": "00000000-0000-0000-0000-000000000000",
      "name": "jumpBoxEnrollment"
    }
  ]
}

Определения

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

Возможность подтвердить, относится ли освобождение или регистрация в рамках или в рамках сферы передачи.

createdByType

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

ErrorAdditionalInfo

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

ErrorDetail

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

ErrorResponse

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

PolicyEnrollment

Регистрация по полису.

PolicyEnrollmentListResult

Реакция операции списка PolicyEnrollment.

ResourceSelector

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

Selector

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

SelectorKind

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

systemData

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

AssignmentScopeValidation

Возможность подтвердить, относится ли освобождение или регистрация в рамках или в рамках сферы передачи.

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

Этот параметр проверяет, находится ли исключение в области назначения или находится под ней.

DoNotValidate

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

createdByType

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

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

ErrorAdditionalInfo

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

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

object

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

type

string

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

ErrorDetail

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

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

ErrorAdditionalInfo[]

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

code

string

Код ошибки.

details

ErrorDetail[]

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

message

string

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

target

string

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

ErrorResponse

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

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

ErrorDetail

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

PolicyEnrollment

Регистрация по полису.

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

string

ETag для регистрации по полису.

id

string (arm-id)

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

name

string

Имя ресурса

properties.assignmentScopeValidation

AssignmentScopeValidation

Вопрос о валидации регистрации находится в рамках или в рамках сферы передачи.

properties.description

string

Описание регистрации по полису.

properties.displayName

string

Отображаемое название регистрации полиса.

properties.metadata

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

properties.policyAssignmentId

string (arm-id)

ID назначения полиса, который регистрируется.

properties.policyAssignmentInstanceId

string (uuid)

ID экземпляра назначения полиса, связанный с этой регистрацией. Значение устанавливается в идентификатор экземпляра присвоения политики, на которую ссылается policyAssignmentId при создании или обновлении регистрации. Формат — это строка GUID.

properties.policyDefinitionReferenceIds

string[]

Определения политики ссылаются на идентификаторы определений политик в назначенном наборе политик. Эти идентификаторы соответствуют подмножеству в policyDefinitions[*].policyDefinitionReferenceId определении набора политик. Когда они указаны и не пусты, будут зачислены только соответствующие определения политик. В противном случае весь набор полисов регистрируется в

properties.resourceSelectors

ResourceSelector[]

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

systemData

systemData

Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.

type

string

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

PolicyEnrollmentListResult

Реакция операции списка PolicyEnrollment.

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

string (uri)

Ссылка на следующую страницу элементов

value

PolicyEnrollment[]

Пункты PolicyEnrollment на этой странице

ResourceSelector

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

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

string

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

selectors

Selector[]

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

Selector

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

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

string[]

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

kind

SelectorKind

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

notIn

string[]

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

SelectorKind

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

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

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

resourceType

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

resourceWithoutLocation

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

policyDefinitionReferenceId

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

userPrincipalId

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

groupPrincipalId

Тип селектора фильтрует политики по идентификатору членства группы безопасности.

systemData

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

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

string (date-time)

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

createdBy

string

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

createdByType

createdByType

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

lastModifiedAt

string (date-time)

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

lastModifiedBy

string

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

lastModifiedByType

createdByType

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