Share via


KeyClient.RestoreKeyBackup(Byte[], CancellationToken) Method

Definition

Restores a backed up key to a vault.

public virtual Azure.Response<Azure.Security.KeyVault.Keys.KeyVaultKey> RestoreKeyBackup (byte[] backup, System.Threading.CancellationToken cancellationToken = default);
abstract member RestoreKeyBackup : byte[] * System.Threading.CancellationToken -> Azure.Response<Azure.Security.KeyVault.Keys.KeyVaultKey>
override this.RestoreKeyBackup : byte[] * System.Threading.CancellationToken -> Azure.Response<Azure.Security.KeyVault.Keys.KeyVaultKey>
Public Overridable Function RestoreKeyBackup (backup As Byte(), Optional cancellationToken As CancellationToken = Nothing) As Response(Of KeyVaultKey)

Parameters

backup
Byte[]

The backup blob associated with a key.

cancellationToken
CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Exceptions

backup is an empty string.

backup is null.

The server returned an error. See Message for details returned from the server.

Remarks

Imports a previously backed up key into Azure Key Vault, restoring the key, its key identifier, attributes, and access control policies. The RESTORE operation may be used to import a previously backed up key. Individual versions of a key cannot be restored. The key is restored in its entirety with the same key name as it had when it was backed up. If the key name is not available in the target Key Vault, the RESTORE operation will be rejected. While the key name is retained during restore, the final key identifier will change if the key is restored to a different vault. Restore will restore all versions and preserve version identifiers. The RESTORE operation is subject to security constraints: The target Key Vault must be owned by the same Microsoft Azure Subscription as the source Key Vault The user must have RESTORE permission in the target Key Vault. This operation requires the keys/restore permission.

Applies to