Role Definitions - List

Служба:: Key Vault

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

Получите все определения ролей, применимые в области и выше.

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

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

GET {vaultBaseUrl}/{scope}/providers/Microsoft.Authorization/roleDefinitions?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	Фильтр, применяемый к операции. Используйте фильтр atScopeAndBelow для поиска ниже заданной области.

Ответы

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

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

OAuth2Auth

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

Области

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

Примеры

Get all role definitions that are applicable at scope and above

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

HTTP

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

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

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

{
  "value": [
    {
      "properties": {
        "roleName": "Role name",
        "type": "roletype",
        "description": "Role description",
        "assignableScopes": [
          "/keys"
        ],
        "permissions": [
          {
            "actions": [
              "get"
            ],
            "notActions": []
          }
        ]
      },
      "id": "/keys/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId",
      "type": "Microsoft.Authorization/roleDefinitions",
      "name": "roleDefinitionId"
    }
  ]
}

Определения

Имя	Описание
DataAction	Поддерживаемые разрешения для действий с данными.
Error
KeyVaultError	Исключение ошибки хранилища ключей.
Permission	Разрешения на определение ролей.
RoleDefinition	Определение роли.
RoleDefinitionListResult	Результат операции со списком определений ролей.
RoleDefinitionType	Тип определения роли.
RoleScope	Область действия роли.
RoleType	Тип роли.

DataAction

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

Поддерживаемые разрешения для действий с данными.

Значение	Описание
Microsoft.KeyVault/managedHsm/keys/read/action	Чтение метаданных ключа HSM.
Microsoft.KeyVault/managedHsm/keys/write/action	Обновите ключ HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action	Чтение удаленного ключа HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action	Восстановите удаленный ключ HSM.
Microsoft.KeyVault/managedHsm/keys/backup/action	Резервное копирование ключей HSM.
Microsoft.KeyVault/managedHsm/keys/restore/action	Восстановите ключи HSM.
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action	Удалите назначение ролей.
Microsoft.KeyVault/managedHsm/roleAssignments/read/action	Получите назначение ролей.
Microsoft.KeyVault/managedHsm/roleAssignments/write/action	Создание или обновление назначения ролей.
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action	Получите определение роли.
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action	Создание или обновление определения роли.
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action	Удалите определение роли.
Microsoft.KeyVault/managedHsm/keys/encrypt/action	Шифрование с помощью ключа HSM.
Microsoft.KeyVault/managedHsm/keys/decrypt/action	Расшифровка с помощью ключа HSM.
Microsoft.KeyVault/managedHsm/keys/wrap/action	Оберните упаковку с помощью ключа HSM.
Microsoft.KeyVault/managedHsm/keys/unwrap/action	Распакуйте с помощью ключа HSM.
Microsoft.KeyVault/managedHsm/keys/sign/action	Подпишитесь с помощью ключа HSM.
Microsoft.KeyVault/managedHsm/keys/verify/action	Подтвердите с помощью ключа HSM.
Microsoft.KeyVault/managedHsm/keys/create	Создайте ключ HSM.
Microsoft.KeyVault/managedHsm/keys/delete	Удалите ключ HSM.
Microsoft.KeyVault/managedHsm/keys/export/action	Экспорт ключа HSM.
Microsoft.KeyVault/managedHsm/keys/release/action	Освободите ключ HSM с помощью функции Secure Key Release.
Microsoft.KeyVault/managedHsm/keys/import/action	Импортируйте ключ HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete	Очистите удаленный ключ HSM.
Microsoft.KeyVault/managedHsm/securitydomain/download/action	Загрузите домен безопасности HSM.
Microsoft.KeyVault/managedHsm/securitydomain/download/read	Проверьте статус загрузки защищенного домена HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/action	Загрузите домен безопасности HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/read	Проверьте состояние файла обмена доменами безопасности HSM.
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read	Скачайте ключ передачи домена безопасности HSM.
Microsoft.KeyVault/managedHsm/backup/start/action	Запустите резервное копирование HSM.
Microsoft.KeyVault/managedHsm/restore/start/action	Запустите восстановление HSM.
Microsoft.KeyVault/managedHsm/backup/status/action	Чтение состояния резервной копии HSM.
Microsoft.KeyVault/managedHsm/restore/status/action	Чтение состояния восстановления HSM.
Microsoft.KeyVault/managedHsm/rng/action	Генерируйте случайные числа.

Error

Object

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

KeyVaultError

Object

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

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

Permission

Object

Разрешения на определение ролей.

Имя	Тип	Описание
actions	string[]	Предоставленные разрешения на действие.
dataActions	DataAction[]	Предоставленные разрешения на действия с данными.
notActions	string[]	Разрешения на действия, которые исключены, но не запрещены. Они могут быть предоставлены другими определениями ролей, назначенными участнику.
notDataActions	DataAction[]	Разрешения на действия с данными, которые исключены, но не запрещены. Они могут быть предоставлены другими определениями ролей, назначенными участнику.

RoleDefinition

Object

Определение роли.

Имя	Тип	Описание
id	string	Идентификатор определения роли.
name	string	Имя определения роли.
properties.assignableScopes	RoleScope[]	Определение роли, назначаемые области.
properties.description	string	Описание определения роли.
properties.permissions	Permission[]	Разрешения на определение ролей.
properties.roleName	string	Имя роли.
properties.type	RoleType	Тип роли.
type	RoleDefinitionType	Тип определения роли.

RoleDefinitionListResult

Object

Результат операции со списком определений ролей.

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

RoleDefinitionType

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

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

Значение	Описание
Microsoft.Authorization/roleDefinitions	Определения ролей, определенные корпорацией Майкрософт.

RoleScope

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

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

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

RoleType

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

Тип роли.

Значение	Описание
AKVBuiltInRole	Встроенная роль.
CustomRole	Пользовательская роль.

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

Role Definitions - List

Параметры URI

Ответы

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

OAuth2Auth

Области

Примеры

Get all role definitions that are applicable at scope and above

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

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

Определения

DataAction

Error

KeyVaultError

Permission

RoleDefinition

RoleDefinitionListResult

RoleDefinitionType

RoleScope

RoleType