Справочник по REST API для Azure Key Vault

  • Статья

Используйте Key Vault для защиты и управления криптографическими ключами, сертификатами и секретами, используемыми облачными приложениями и службами.

Операции с хранилищем ключей

Операция Описание
Проверяет доступность имени. Проверяет, является ли имя хранилища допустимым и еще не используется.
Создание или обновление Создайте или обновите хранилище ключей в указанной подписке.
Обновление политики доступа Обновление политик доступа в хранилище ключей в указанной подписке.
Get Возвращает указанное хранилище ключей Azure.
Список Операция List получает сведения о хранилищах, связанных с подпиской.
вывод списка по группе ресурсов Операция List получает сведения о хранилищах, связанных с подпиской и в указанной группе ресурсов.
Вывод списка по подпискам Операция List получает сведения о хранилищах, связанных с подпиской.
Обновление Обновление хранилища ключей в указанной подписке.
Удалить Удаляет указанное хранилище ключей Azure.
Получить удаление Возвращает удаленное хранилище ключей Azure.
Список удаленных Возвращает сведения об удаленных хранилищах в подписке.
Purge Безвозвратно удаляет указанное хранилище.
Операция Описание
Список по хранилищу Возвращает ресурсы приватного канала, поддерживаемые для хранилища ключей.

Операции с подключениями к частной конечной точке

Операция Описание
Get Возвращает указанное подключение к частной конечной точке, связанное с хранилищем ключей.
Список по ресурсу Операция List получает сведения о подключениях к частной конечной точке, связанных с хранилищем.
Положить Обновления указанное подключение к частной конечной точке, связанное с хранилищем ключей.
Удалить Удаляет указанное подключение к частной конечной точке, связанное с хранилищем ключей.

Операции управляемого устройства HSM

Операция Описание
Создание или обновление Создайте или обновите управляемый пул HSM в указанной подписке.
Get Возвращает указанный пул управляемого устройства HSM.
вывод списка по группе ресурсов Операция List получает сведения об управляемых пулах HSM, связанных с подпиской и в указанной группе ресурсов.
Вывод списка по подпискам Операция List получает сведения об управляемых пулах HSM, связанных с подпиской.
Обновление Обновление пула управляемых устройств HSM в указанной подписке.
Получить удаление Возвращает указанный удаленный управляемый модуль HSM.
Список удаленных Операция List получает сведения об удаленных управляемых модулях HSM, связанных с подпиской.
Удалить Удаляет указанный управляемый пул HSM.
Очистка удалена Безвозвратно удаляет указанный управляемый модуль HSM.
Операция Описание
Список по ресурсу MHSM Возвращает ресурсы приватного канала, поддерживаемые для управляемого пула HSM.

Операции с подключениями к частной конечной точке

Операция Описание
Get Возвращает указанное подключение к частной конечной точке, связанное с управляемым пулом HSM.
Список по ресурсу Операция List получает сведения о подключениях к частной конечной точке, связанных с управляемым пулом HSM.
Положить Обновления указанное подключение к частной конечной точке, связанное с управляемым пулом HSM.
Удалить Удаляет указанное подключение к частной конечной точке, связанное с управляемым пулом HSM.

Операции с доменом безопасности HSM

Операция Описание
Загрузить Извлекает домен безопасности из управляемого устройства HSM. Вызов этой конечной точки можно использовать для активации подготовленного ресурса управляемого устройства HSM.
Ожидание скачивания Возвращает состояние операции скачивания домена безопасности.
Отправка Восстановите указанный домен безопасности.
Ожидание отправки Получение состояния операции отправки домена безопасности.

Операции с параметрами управляемого устройства HSM

Операция Описание
Получение параметра Получение указанного объекта параметров учетной записи. Извлекает объект параметра с указанным именем параметра.
Получение параметров Вывод списка параметров учетной записи. Извлекает список всех доступных параметров учетной записи, которые можно настроить.
Обновление параметра Обновления параметр учетной записи хранилища ключей сохраняет его, а затем возвращает клиенту имя и значение параметра. Описание обновляемого параметра пула

Операции управления доступом на основе ролей

Операции назначения ролей

Операция Описание
Get Получение указанного назначения роли.
Список Возвращает назначения ролей для область.
Создание Создает назначение роли.
Удалить Удаляет назначение ролей.

Операции определения ролей

Операция Описание
Get Получение указанного определения роли.
Список Получение всех определений ролей, применимых в область и более поздних версий.
Создание или обновление Создает или обновляет пользовательское определение роли.
Удалить Удаляет пользовательское определение роли.

Операции резервного копирования и восстановления

Операция Описание
Полная резервная копия Создает полную резервную копию с помощью предоставленного пользователем маркера SAS в контейнер хранилища BLOB-объектов Azure. Эта операция поддерживается только управляемой службой HSM.
Состояние резервного копирования Возвращает состояние операции полного резервного копирования.
Полное восстановление Восстанавливает все ключевые материалы с помощью маркера SAS, указывающего на ранее сохраненную папку резервного копирования хранилища BLOB-объектов Azure.
Выборочное восстановление Восстанавливает все версии ключей заданного ключа с помощью предоставленного пользователем маркера SAS, указывающего на ранее сохраненную папку резервного копирования хранилища BLOB-объектов Azure.
Состояние восстановления Возвращает состояние операции восстановления.

Операции с ключами (Key Vault или управляемый модуль HSM)

Операция Описание
Получение ключа Возвращает открытую часть хранимого ключа.
Получение ключей Вывод списка ключей в указанном хранилище.
Получение версий ключей Извлекает список отдельных версий ключей с тем же именем ключа.
Создать ключ Создает новый ключ, сохраняет его, возвращает параметры и атрибуты ключа клиенту.
Импорт ключа Импортирует созданный внешне ключ, сохраняет его, а также возвращает параметры и атрибуты ключа клиенту.
Обновление ключа Операция обновления ключа изменяет указанные атрибуты хранимого ключа и может применяться к любому типу ключа и версии ключа, хранящимся в Azure Key Vault.
Удаление ключа Удаляет ключ любого типа из хранилища в Azure Key Vault.
Получение удаленного ключа Возвращает открытую часть удаленного ключа.
Получение удаленных ключей Выводит список удаленных ключей в указанном хранилище.
Очистка удаленного ключа Безвозвратно удаляет указанный ключ.
Восстановление удаленного ключа Восстанавливает удаленный ключ до последней версии.
Создание резервной копии ключа Запрашивает скачивание на клиент резервной копии указанного ключа.
Восстановление ключа Восстанавливает резервную копию ключа в хранилище.
Ключ выпуска Освобождает ключ. Операция с ключом выпуска применима ко всем типам ключей. Целевой ключ должен быть помечен как экспортируемый. Для этой операции требуется разрешение "Ключи/выпуск".
Смена клавиши Создает новую версию ключа, сохраняет ее, а затем возвращает клиенту параметры ключа, атрибуты и политику. Операция сменит ключ на основе политики ключей. Для этого требуется разрешение на смену ключей.
Получение политики смены ключей Выводит список политики для ключа. Операция GetKeyRotationPolicy возвращает указанные ресурсы политики ключей в указанном хранилище ключей. Для этой операции требуется разрешение keys/get.
Обновление политики смены ключей Обновления политики смены ключа. Задайте указанные члены в политике ключей. Оставьте другие как неопределенные. Для этой операции требуются ключи или разрешение на обновление.

Операции с ключами (только управляемый модуль HSM)

Операция Описание
Получение случайных байтов Получение запрошенного числа байтов, содержащих случайные значения, из управляемого модуля HSM.

Криптографические операции (Key Vault или управляемый модуль HSM)

Операция Описание
Decrypt Расшифровывает один блок зашифрованных данных.
Encrypt Шифрует произвольную последовательность байтов с помощью ключа шифрования, хранящегося в хранилище ключей.
Перенос ключа Заключает симметричный ключ в оболочку с помощью указанного ключа.
Распаковка ключа Распаковывает симметричный ключ, используя указанный ключ, который изначально использовался для упаковки этого ключа.
Подпись Создает сигнатуру из дайджеста, используя указанный ключ.
Проверка Проверяет подпись с помощью указанного ключа.

Операции с секретами (только Key Vault)

Операция Описание
Получение секрета Получение указанного секрета из заданного хранилища ключей.
Получение секретов Вывод списка секретов в указанном хранилище ключей.
Получение версий секретов Перечисление всех версий указанного секрета.
Установка секрета Задает секрет в указанном хранилище ключей.
Обновление секрета Обновления атрибуты, связанные с указанным секретом в данном хранилище ключей.
Удаление секрета Удаляет секрет из указанного хранилища ключей.
Получение удаленного секрета Возвращает указанный удаленный секрет.
Получение удаленных секретов Выводит список удаленных секретов для указанного хранилища.
Очистка удаленного секрета Безвозвратно удаляет указанный секрет.
Восстановление удаленного секрета Восстанавливает удаленный секрет до последней версии.
Создание резервной копии секрета Резервное копирование указанного секрета.
Восстановление секрета Восстанавливает резервную копию секрета в хранилище.

Операции управления ключами учетной записи хранения (только Key Vault)

Операции с конфигурацией учетной записи хранения

Операция Описание
Получение учетной записи хранения Возвращает сведения об указанной учетной записи хранения. Для этой операции требуется разрешение на хранение или получение.
Получение учетных записей хранения Список учетных записей хранения, управляемых указанным хранилищем ключей. Для этой операции требуется разрешение хранилища или списка.
Обновление учетной записи хранения Обновления указанные атрибуты, связанные с данной учетной записью хранения. Для этой операции требуется разрешение на хранение, набор или обновление.
Настройка учетной записи хранения Создает или обновляет новую учетную запись хранения. Для этой операции требуется разрешение на хранение или набор.
Удаление учетной записи хранения Удаляет учетную запись хранения. Для этой операции требуется разрешение на хранение или удаление.
Получение удаленной учетной записи хранения Возвращает указанную удаленную учетную запись хранения.
Получение удаленных учетных записей хранения Список удаленных учетных записей хранения для указанного хранилища.
Очистка удаленной учетной записи хранения Безвозвратно удаляет указанную учетную запись хранения.
Восстановление удаленной учетной записи хранения Восстанавливает удаленную учетную запись хранения.
Учетная запись хранения резервного копирования Резервное копирование указанной учетной записи хранения.
Восстановление учетной записи хранения Восстанавливает резервную копию учетной записи хранения в хранилище.

Операции с ключами учетной записи хранения

Операция Описание
Повторное создание ключа учетной записи хранения Повторно создает указанное значение ключа для заданной учетной записи хранения. Для этой операции требуется разрешение storage/regeneratekey.

Операции SAS учетной записи хранения

Операция Описание
Получение определения SAS Возвращает сведения об определении SAS для указанной учетной записи хранения. Для этой операции требуется разрешение storage/getsas.
Получение определений SAS Перечисление определений SAS хранилища для данной учетной записи хранения. Для этой операции требуется разрешение storage/listsas.
Задать определение SAS Создает или обновляет новое определение SAS для указанной учетной записи хранения. Для этой операции необходимо разрешение storage/setsas.
Обновление определения SAS Обновления указанные атрибуты, связанные с заданным определением SAS. Для этой операции необходимо разрешение storage/setsas.
Удаление определения SAS Удаляет определение SAS из указанной учетной записи хранения. Для этой операции требуется разрешение storage/deletesas.
Получение определения удаленного SAS Возвращает указанное определение удаленного SAS.
Получение удаленных определений SAS Список удаленных определений SAS для указанного хранилища и учетной записи хранения.
Восстановление определения удаленного SAS Восстанавливает удаленное определение SAS.

Операции с сертификатами (только Key Vault)

Операция Описание
Получение сертификата Возвращает сведения о сертификате.
Получение сертификатов Перечисление сертификатов в указанном хранилище ключей
Получение версий сертификатов Перечисление версий сертификата.
Создание сертификата Создание нового сертификата.
Импорт сертификата Импортирует сертификат в указанное хранилище ключей.
Слияние сертификата Объединяет сертификат или цепочку сертификатов с парой ключей, существующей на сервере.
Операция получения сертификата Возвращает операцию создания сертификата.
Операция обновления сертификата Обновления операции с сертификатом.
Операция удаления сертификата Удаляет операцию создания для определенного сертификата.
Обновление сертификата Обновление указанных атрибутов, связанных с определенным сертификатом.
Удаление сертификата Удаляет сертификат из указанного хранилища ключей.
Получение удаленного сертификата Извлекает сведения об указанном удаленном сертификате.
Получение удаленных сертификатов Список удаленных сертификатов в указанном хранилище, доступном для восстановления.
Очистка удаленного сертификата Безвозвратно удаляет указанный удаленный сертификат.
Восстановление удаленного сертификата Восстанавливает удаленный сертификат до текущей версии в разделе /certificates.
Создание резервной копии сертификата Резервное копирование указанного сертификата.
Восстановление сертификата Восстанавливает сертификат из резервной копии в хранилище.

Операции с политикой сертификатов

Операция Описание
Получение политики сертификатов Перечисляет политику для сертификата.
Обновление политики сертификатов Обновления политику для сертификата.

Операции с контактами сертификатов

Операция Описание
Получение контактов сертификатов Список контактов сертификата для указанного хранилища ключей.
Настройка контактов сертификатов Задает контакты сертификата для указанного хранилища ключей.
Удаление контактов сертификатов Удаляет контакты сертификата для указанного хранилища ключей.

Операции издателя сертификата

Операция Описание
Получение издателя сертификата Перечисляет указанного издателя сертификата.
Получение издателей сертификатов Вывод списка издателей сертификатов для указанного хранилища ключей.
Установка издателя сертификата Задает указанного издателя сертификата.
Обновление издателя сертификата Обновления указанного издателя сертификата.
Удаление издателя сертификата Удаляет указанного издателя сертификата.

См. также раздел