Selective Key Restore Operation - Selective Key Restore Operation

Service:

Key Vault

API Version:

7.4

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

PUT {vaultBaseUrl}/keys/{keyName}/restore?api-version=7.4

Параметры URI

Имя	В	Обязательно	Тип	Описание
keyName	path	True	string	Имя ключа для восстановления из предоставленной пользователем резервной копии
vaultBaseUrl	path	True	string	Имя хранилища, например https://myvault.vault.azure.net.
api-version	query	True	string	Версия API клиента.

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

Имя	Обязательно	Тип	Описание
folder	True	string	Имя папки большого двоичного объекта, в котором была сохранена предыдущая успешная полная резервная копия.
sasTokenParameters	True	SASTokenParameter

Ответы

Имя	Тип	Описание
202 Accepted	SelectiveKeyRestoreOperation	Запущена операция выборочного восстановления ключа из ранее сохраненной резервной копии Headers Retry-After: integer Azure-AsyncOperation: string
Other Status Codes	KeyVaultError	Key Vault ответ об ошибке, описывающий причину сбоя операции.

Примеры

Selectively restore key from a backup

Sample Request

HTTP

PUT https://myvault.vault.azure.net/keys/hsm-mail-key/restore?api-version=7.4

{
  "sasTokenParameters": {
    "storageResourceUri": "https://myaccount.blob.core.windows.net/sascontainer/sasContainer",
    "token": "se=2018-02-01T00%3A00Z&spr=https&sv=2017-04-17&sr=b&sig=XXFNfuMCH112BxhemJ7PWn0xGfImMXT6LfbXWvtRUk%3D"
  },
  "folder": "mhsm-mypool-20200303062926785"
}

Sample Response

Status code:

202

Retry-After: 5
Azure-AsyncOperation: https://myvault.vault.azure.net/restore/45aacd568a23b0s49a2803861e8dd3ase21f/pending

Response Body

{
  "status": "InProgress",
  "statusDetails": "Selective Key restore is in progress",
  "jobId": "45aacd568a23b0s49a2803861e8dd3ase21f",
  "startTime": 1490790000,
  "endTime": 0
}

Определения

Имя	Описание
Error	Ошибка сервера хранилища ключей.
KeyVaultError	Исключение ошибки хранилища ключей.
SASTokenParameter
SelectiveKeyRestoreOperation	Операция выборочного восстановления ключа
SelectiveKeyRestoreOperationParameters

Error

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

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

KeyVaultError

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

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

SASTokenParameter

Имя	Тип	Описание
storageResourceUri	string	URI контейнера хранилища BLOB-объектов Azure
token	string	Маркер SAS, указывающий на контейнер хранилища BLOB-объектов Azure

SelectiveKeyRestoreOperation

Операция выборочного восстановления ключа

Имя	Тип	Описание
endTime	integer	Время окончания операции восстановления
error	Error	Ошибка, если она есть, во время операции выборочного восстановления ключа.
jobId	string	Идентификатор для операции выборочного восстановления ключа.
startTime	integer	Время начала операции восстановления
status	string	Состояние операции восстановления.
statusDetails	string	Сведения о состоянии операции восстановления.

SelectiveKeyRestoreOperationParameters

Имя	Тип	Описание
folder	string	Имя папки большого двоичного объекта, в котором была сохранена предыдущая успешная полная резервная копия.
sasTokenParameters	SASTokenParameter