Role Definitions - Create Or Update

Service:

Key Vault

API Version:

7.4

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
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 клиента.

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

Имя	Обязательно	Тип	Описание
properties	True	RoleDefinitionProperties	Свойства определения роли.

Ответы

Имя	Тип	Описание
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.4

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

Определения

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

DataAction

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

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

Error

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

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

KeyVaultError

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

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

Permission

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

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

RoleDefinition

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

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

RoleDefinitionCreateParameters

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

Имя	Тип	Описание
properties	RoleDefinitionProperties	Свойства определения роли.

RoleDefinitionProperties

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

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

RoleDefinitionType

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

Имя	Тип	Описание
Microsoft.Authorization/roleDefinitions	string

RoleScope

Роль область.

Имя	Тип	Описание
/	string	Глобальная область
/keys	string	Ключи область

RoleType

Тип роли.

Имя	Тип	Описание
AKVBuiltInRole	string	Встроенная роль.
CustomRole	string	Настраиваемая роль.