Full Backup - Full Backup

Service:

Key Vault

API Version:

7.4

Creates a full backup using a user-provided SAS token to an Azure blob storage container.

POST {vaultBaseUrl}/backup?api-version=7.4

URI Parameters

Name	In	Required	Type	Description
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
storageResourceUri	True	string	Azure Blob storage container Uri
token	True	string	The SAS token pointing to an Azure Blob storage container

Responses

Name	Type	Description
202 Accepted	FullBackupOperation	Started full backup Headers Retry-After: integer Azure-AsyncOperation: string
Other Status Codes	KeyVaultError	Key Vault error response describing why the operation failed.

Examples

Create full backup

Sample Request

HTTP

POST https://myvault.vault.azure.net//backup?api-version=7.4

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

Sample Response

Status code:

202

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

Response Body

{
  "status": "InProgress",
  "statusDetails": "Full backup is in progress",
  "azureStorageBlobContainerUri": "https://myaccount.blob.core.windows.net/sascontainer/fullbackup-pool-61e8dd3ae21f-1579243113",
  "jobId": "45aacd568ab049a2803861e8dd3ae21f",
  "startTime": 1490790000,
  "endTime": 0
}

Definitions

Name	Description
Error	The key vault server error.
FullBackupOperation	Full backup operation
KeyVaultError	The key vault error exception.
SASTokenParameter

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.

FullBackupOperation

Full backup operation

Name	Type	Description
azureStorageBlobContainerUri	string	The Azure blob storage container Uri which contains the full backup
endTime	integer	The end time of the backup operation in UTC
error	Error	Error encountered, if any, during the full backup operation.
jobId	string	Identifier for the full backup operation.
startTime	integer	The start time of the backup operation in UTC
status	string	Status of the backup operation.
statusDetails	string	The status details of backup operation.

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