Selective Key Restore Operation - Selective Key Restore Operation

Service:

Key Vault

API Version:

7.4

Restores all key versions of a given key using user supplied SAS token pointing to a previously stored Azure Blob storage backup folder

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

URI Parameters

Name	In	Required	Type	Description
keyName	path	True	string	The name of the key to be restored from the user supplied backup
vaultBaseUrl	path	True	string	The vault name, for example https://myvault.vault.azure.net.
api-version	query	True	string	Client API version.

Request Body

Name	Required	Type	Description
folder	True	string	The Folder name of the blob where the previous successful full backup was stored
sasTokenParameters	True	SASTokenParameter

Responses

Name	Type	Description
202 Accepted	SelectiveKeyRestoreOperation	Started selective key restore operation from the previously stored backup Headers Retry-After: integer Azure-AsyncOperation: string
Other Status Codes	KeyVaultError	Key Vault error response describing why the operation failed.

Examples

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
}

Definitions

Name	Description
Error	The key vault server error.
KeyVaultError	The key vault error exception.
SASTokenParameter
SelectiveKeyRestoreOperation	Selective Key Restore operation
SelectiveKeyRestoreOperationParameters

Error

The key vault server error.

Name	Type	Description
code	string	The error code.
innererror	Error	The key vault server error.
message	string	The error message.

KeyVaultError

The key vault error exception.

Name	Type	Description
error	Error	The key vault server error.

SASTokenParameter

Name	Type	Description
storageResourceUri	string	Azure Blob storage container Uri
token	string	The SAS token pointing to an Azure Blob storage container

SelectiveKeyRestoreOperation

Selective Key Restore operation

Name	Type	Description
endTime	integer	The end time of the restore operation
error	Error	Error encountered, if any, during the selective key restore operation.
jobId	string	Identifier for the selective key restore operation.
startTime	integer	The start time of the restore operation
status	string	Status of the restore operation.
statusDetails	string	The status details of restore operation.

SelectiveKeyRestoreOperationParameters

Name	Type	Description
folder	string	The Folder name of the blob where the previous successful full backup was stored
sasTokenParameters	SASTokenParameter