Role Definitions - Create Or Update

Ссылка

Service:: Key Vault

API Version:: 7.3

Создает или обновляет определение настраиваемой роли.

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

Параметры URI

Name	In	Required	Type	Description
roleDefinitionName	path	True	string	Имя определения роли для создания или обновления. Это может быть любой допустимый GUID.
scope	path	True	string	Область определения роли для создания или обновления. Управляемый модуль HSM поддерживает только "/".
vaultBaseUrl	path	True	string	Имя хранилища, например https://myvault.vault.azure.net.
api-version	query	True	string	Версия API клиента.

Текст запроса

Name	Required	Type	Description
properties	True	RoleDefinitionProperties	Свойства определения роли.

Ответы

Name	Type	Description
201 Created	RoleDefinition	Создано — возвращает сведения об определении роли.
Other Status Codes	KeyVaultError	Key Vault ответ об ошибке, описывающий причину сбоя операции.

Примеры

PutRoleDefinition

Sample Request

HTTP

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

{
  "properties": {
    "roleName": "My custom role",
    "type": "CustomRole",
    "description": "Role description",
    "permissions": [
      {
        "dataActions": [
          "Microsoft.KeyVault/managedHsm/keys/sign/action"
        ]
      }
    ]
  }
}

Sample Response

Status code:: 201

{
  "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	Определение роли.
RoleDefinitionCreateParameters	Определение роли создает параметры.
RoleDefinitionProperties	Свойства определения роли.
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	Тип определения роли.

RoleDefinitionCreateParameters

Определение роли создает параметры.

Name	Type	Description
properties	RoleDefinitionProperties	Свойства определения роли.

RoleDefinitionProperties

Свойства определения роли.

Name	Type	Description
assignableScopes	string[]	Области, назначаемые определением роли.
description	string	Описание определения роли.
permissions	Permission[]	Разрешения определения роли.
roleName	string	Имя роли.
type	RoleType	Тип роли.

RoleDefinitionType

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

Name	Type	Description
Microsoft.Authorization/roleDefinitions	string

RoleType

Тип роли.

Name	Type	Description
AKVBuiltInRole	string	Встроенная роль.
CustomRole	string	Пользовательская роль.