Role Definitions - List

Ссылка

Service:: Key Vault

API Version:: 7.3

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

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

With optional parameters:

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

Параметры URI

Name	In	Required	Type	Description
scope	path	True	string	Область определения роли.
vaultBaseUrl	path	True	string	Имя хранилища, например https://myvault.vault.azure.net.
api-version	query	True	string	Версия API клиента.
$filter	query		string	Фильтр, применяемый к операции. Используйте фильтр atScopeAndBelow для поиска под заданной областью.

Ответы

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

Примеры

ListRoleDefinitions

Sample Request

HTTP

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

Sample Response

Status code:: 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"
    }
  ]
}

Определения

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

Error

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

Name	Type	Description
code	string	Код ошибки.
innererror	Error	Ошибка сервера хранилища ключей.
message	string	Сообщение об ошибке.

KeyVaultError

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

Name	Type	Description
error	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	Permission[]	Разрешения на определение роли.
properties.roleName	string	Имя роли.
properties.type	RoleType	Тип роли.
type	RoleDefinitionType	Тип определения роли.

RoleDefinitionListResult

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

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

RoleDefinitionType

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

Name	Type	Description
Microsoft.Authorization/roleDefinitions	string

RoleType

Тип роли.

Name	Type	Description
AKVBuiltInRole	string	Встроенная роль.
CustomRole	string	Настраиваемая роль.