Поделиться через

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

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

Операции Key Vault

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

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

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

Операции с ключами (Key Vault/Managed HSM)

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

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

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

Криптографические операции (Key Vault/Managed HSM)

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

Секретные операции (только для Key Vault)

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

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

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

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

Ключевые операции учетной записи хранения

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

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

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

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

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

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

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

Сертификат контактов операций

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

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

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

См. также

  • Last updated on