SecretClient.BackupSecretAsync(String, 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

Backs up the specified secret.

public virtual System.Threading.Tasks.Task<Azure.Response<byte[]>> BackupSecretAsync (string name, System.Threading.CancellationToken cancellationToken = default);

abstract member BackupSecretAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<byte[]>>
override this.BackupSecretAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<byte[]>>

Public Overridable Function BackupSecretAsync (name As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of Byte()))

Parameters

name

String

The name of the secret.

cancellationToken

CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Task<Response<Byte[]>>

Exceptions

ArgumentException

name is an empty string.

ArgumentNullException

name is null.

RequestFailedException

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

Remarks

Requests that a backup of the specified secret be downloaded to the client. All versions of the secret will be downloaded. This operation requires the secrets/backup permission.