SecretClient.RestoreSecretBackupAsync(Byte[], CancellationToken) Method

Definition

Restores a backed up secret to a vault.

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

Parameters

backup
Byte[]

The backup blob associated with a secret.

cancellationToken
CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Exceptions

backup is null.

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

Remarks

Restores a backed up secret, and all its versions, to a vault. This operation requires the secrets/restore permission.

Applies to