KeyClient.RestoreKeyBackupAsync(Byte[], CancellationToken) Method

Definition

Namespace:

Azure.Security.KeyVault.Keys

Assembly:

Azure.Security.KeyVault.Keys.dll

Package:

Azure.Security.KeyVault.Keys v4.7.0

Source:

KeyClient.cs

Restores a backed up key to a vault.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Keys.KeyVaultKey>> RestoreKeyBackupAsync (byte[] backup, System.Threading.CancellationToken cancellationToken = default);

abstract member RestoreKeyBackupAsync : byte[] * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Keys.KeyVaultKey>>
override this.RestoreKeyBackupAsync : byte[] * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Keys.KeyVaultKey>>

Public Overridable Function RestoreKeyBackupAsync (backup As Byte(), Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of KeyVaultKey))

Parameters

backup

Byte[]

The backup blob associated with a key.

cancellationToken

CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Task<Response<KeyVaultKey>>

Exceptions

ArgumentException

backup is an empty string.

ArgumentNullException

backup is null.

RequestFailedException

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.