Share via


SecretClient.RestoreSecretBackup(Byte[], CancellationToken) Method

Definition

Restores a backed up secret to a vault.

public virtual Azure.Response<Azure.Security.KeyVault.Secrets.SecretProperties> RestoreSecretBackup (byte[] backup, System.Threading.CancellationToken cancellationToken = default);
abstract member RestoreSecretBackup : byte[] * System.Threading.CancellationToken -> Azure.Response<Azure.Security.KeyVault.Secrets.SecretProperties>
override this.RestoreSecretBackup : byte[] * System.Threading.CancellationToken -> Azure.Response<Azure.Security.KeyVault.Secrets.SecretProperties>
Public Overridable Function RestoreSecretBackup (backup As Byte(), Optional cancellationToken As CancellationToken = Nothing) As 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