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

  • Статья
  • Чтение занимает 10 мин

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

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

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

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

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

Управляемые операции HSM

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

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

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

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

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

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

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

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

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

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

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

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

Домен безопасности HSM

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

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

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

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

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

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

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

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

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

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

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

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

операции настройки учетной записи служба хранилища

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

операции с ключами учетной записи служба хранилища

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

служба хранилища операции SAS учетной записи

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

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

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

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

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

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

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

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

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

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