Role Assignments - List For Scope

Служба:

Key Vault

Версия API:

2025-07-01

Получает назначения ролей для области.

GET {vaultBaseUrl}/{scope}/providers/Microsoft.Authorization/roleAssignments?api-version=2025-07-01

С использованием необязательных параметров:

GET {vaultBaseUrl}/{scope}/providers/Microsoft.Authorization/roleAssignments?api-version=2025-07-01&$filter={$filter}

Параметры URI

Имя	В	Обязательно	Тип	Описание
scope	path	True	string	Область назначения ролей.
vaultBaseUrl	path	True	string (uri)
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.
$filter	query		string	Фильтр, применяемый к операции. Используйте $filter=atScope() для возврата всех назначений ролей в области видимости или за ее пределами. Используйте $filter=principalId eq {id}, чтобы вернуть все назначения ролей в области, выше или ниже области для указанного участника.

Ответы

Имя	Тип	Описание
200 OK	RoleAssignmentListResult	Запрос выполнен успешно.
Other Status Codes	KeyVaultError	Непредвиденное сообщение об ошибке.

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

OAuth2Auth

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

Области

Имя	Описание
https://vault.azure.net/.default

Примеры

Get role assignments for a scope

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

HTTP

GET https://myvault.vault.azure.net//keys/providers/Microsoft.Authorization/roleAssignments?api-version=2025-07-01

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

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

200

{
  "value": [
    {
      "properties": {
        "roleDefinitionId": "/keys/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId",
        "principalId": "principalId",
        "scope": "/keys"
      },
      "id": "/keys/providers/Microsoft.Authorization/roleAssignments/roleAssignmentId",
      "type": "Microsoft.Authorization/roleAssignments",
      "name": "roleAssignmentId"
    }
  ]
}

Определения

Имя	Описание
Error
KeyVaultError	Исключение ошибки хранилища ключей.
RoleAssignment	Назначения ролей
RoleAssignmentListResult	Результат работы со списком назначений ролей.
RoleAssignmentPropertiesWithScope	Свойства назначения ролей с областью действия.
RoleScope	Область действия роли.

Error

Object

Имя	Тип	Описание
code	string	Код ошибки.
innererror	Error	Ошибка сервера хранилища ключей.
message	string	Сообщение об ошибке.

KeyVaultError

Object

Исключение ошибки хранилища ключей.

Имя	Тип	Описание
error	Error	Ошибка сервера хранилища ключей.

RoleAssignment

Object

Назначения ролей

Имя	Тип	Описание
id	string	Идентификатор назначения роли.
name	string	Имя назначения роли.
properties	RoleAssignmentPropertiesWithScope	Свойства назначения ролей.
type	string	Тип назначения роли.

RoleAssignmentListResult

Object

Результат работы со списком назначений ролей.

Имя	Тип	Описание
nextLink	string	URL-адрес, используемый для получения следующего набора результатов.
value	RoleAssignment[]	Список назначенных ролей.

RoleAssignmentPropertiesWithScope

Object

Свойства назначения ролей с областью действия.

Имя	Тип	Описание
principalId	string	Идентификатор субъекта.
roleDefinitionId	string	Идентификатор определения роли.
scope	RoleScope	Область действия роли.

RoleScope

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

Область действия роли.

Значение	Описание
/	Глобальный охват
/keys	Область применения ключей