Role Definitions - Get

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

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

Параметры URI

Name In Required Type Description
roleDefinitionName
path True
  • string

Имя определения роли, который требуется получить.

scope
path True
  • string

Область определения роли для получения. Управляемый модуль HSM поддерживает только "/".

vaultBaseUrl
path True
  • string

Имя хранилища, например https://myvault.vault.azure.net.

api-version
query True
  • string

Версия API клиента.

Ответы

Name Type Description
200 OK

ОК . Возвращает сведения об определении роли.

Other Status Codes

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

Примеры

GetRoleAssignments

Sample Request

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

Sample Response

{
  "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"
}

Определения

Error

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

KeyVaultError

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

Permission

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

RoleDefinition

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

RoleDefinitionType

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

RoleType

Тип роли.

Error

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

Name Type Description
code
  • string

Код ошибки.

innererror

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

message
  • string

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

KeyVaultError

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

Name Type Description
error

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

Permission

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

Name Type Description
actions
  • string[]

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

dataActions
  • string[]

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

notActions
  • string[]

Разрешения на действия, исключенные, но не запрещенные. Они могут быть предоставлены другими определениями ролей, назначенными субъекту.

notDataActions
  • string[]

Разрешения на действия с данными, которые исключены, но не запрещены. Они могут быть предоставлены другими определениями ролей, назначенными субъекту.

RoleDefinition

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

Name Type Description
id
  • string

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

name
  • string

Имя определения роли.

properties.assignableScopes
  • string[]

Назначаемые области определения ролей.

properties.description
  • string

Описание определения роли.

properties.permissions

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

properties.roleName
  • string

Имя роли.

properties.type

Тип роли.

type

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

RoleDefinitionType

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

Name Type Description
Microsoft.Authorization/roleDefinitions
  • string

RoleType

Тип роли.

Name Type Description
AKVBuiltInRole
  • string

Встроенная роль.

CustomRole
  • string

Настраиваемая роль.