IKeyVaultClient.BackupKeyWithHttpMessagesAsync(String, String, Dictionary<String,List<String>>, CancellationToken) Method

Definition

Namespace:: Microsoft.Azure.KeyVault

Assembly:: Microsoft.Azure.KeyVault.dll

Requests that a backup of the specified key be downloaded to the client.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.KeyVault.Models.BackupKeyResult>> BackupKeyWithHttpMessagesAsync (string vaultBaseUrl, string keyName, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = null, System.Threading.CancellationToken cancellationToken = null);

abstract member BackupKeyWithHttpMessagesAsync : string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.KeyVault.Models.BackupKeyResult>>

Parameters

vaultBaseUrl: String

The vault name, for example https://myvault.vault.azure.net.

keyName: String

The name of the key.

customHeaders: Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<Microsoft.Rest.Azure.AzureOperationResponse<BackupKeyResult>>

Remarks

The Key Backup operation exports a key from Azure Key Vault in a

protected form. Note that this operation does NOT return key

material in a form that can be used outside the Azure Key Vault

system, the returned key material is either protected to a Azure

Key Vault HSM or to Azure Key Vault itself. The intent of this

operation is to allow a client to GENERATE a key in one Azure Key

Vault instance, BACKUP the key, and then RESTORE it into another

Azure Key Vault instance. The BACKUP operation may be used to

export, in protected form, any key type from Azure Key Vault.

Individual versions of a key cannot be backed up. BACKUP / RESTORE

can be performed within geographical boundaries only; meaning that

a BACKUP from one geographical area cannot be restored to another

geographical area. For example, a backup from the US geographical

area cannot be restored in an EU geographical area.