SecretClient.RestoreSecretBackupAsync(Byte[], CancellationToken) Method

Definition

Namespace:

Azure.Security.KeyVault.Secrets

Assembly:

Azure.Security.KeyVault.Secrets.dll

Package:

Azure.Security.KeyVault.Secrets v4.7.0

Source:

SecretClient.cs

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

Task<Response<SecretProperties>>

Exceptions

ArgumentNullException

backup is null.

RequestFailedException

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.