Role Definitions - Get

Служба:

Key Vault

Версия API:

7.4

Получите определение указанной роли.

GET {vaultBaseUrl}/{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionName}?api-version=7.4

Параметры URI

Имя	В	Обязательно	Тип	Описание
roleDefinitionName	path	True	string	Имя определения роли, который требуется получить.
scope	path	True	string	Область определения роли для получения. Управляемый HSM поддерживает только "/".
vaultBaseUrl	path	True	string	Имя хранилища, например https://myvault.vault.azure.net.
api-version	query	True	string	Версия КЛИЕНТСКОго API.

Ответы

Имя	Тип	Описание
200 OK	RoleDefinition	ОК. Возвращает сведения о определении роли.
Other Status Codes	KeyVaultError	Ответ об ошибке Key Vault, описывающий причину сбоя операции.

Примеры

GetRoleAssignments

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

HTTP

GET https://myvault.vault.azure.net////providers/Microsoft.Authorization/roleDefinitions/00000000-0000-0000-0000-000000000000?api-version=7.4

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

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

200

{
  "properties": {
    "roleName": "My custom role",
    "type": "CustomRole",
    "description": "Role description",
    "assignableScopes": [
      "/"
    ],
    "permissions": [
      {
        "dataActions": [
          "Microsoft.KeyVault/managedHsm/keys/sign/action"
        ]
      }
    ]
  },
  "id": "Microsoft.KeyVault/providers/Microsoft.Authorization/roleDefinitions/00000000-0000-0000-0000-000000000000",
  "type": "Microsoft.Authorization/roleDefinitions",
  "name": "00000000-0000-0000-0000-000000000000"
}

Определения

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

DataAction

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

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

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

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	Тип определения роли.

RoleDefinitionType

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

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

Значение	Описание
Microsoft.Authorization/roleDefinitions

RoleScope

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

Область роли.

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

RoleType

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

Тип роли.

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