Share via


SecretClient.BackupSecret(String, CancellationToken) Method

Definition

Backs up the specified secret.

public virtual Azure.Response<byte[]> BackupSecret (string name, System.Threading.CancellationToken cancellationToken = default);
abstract member BackupSecret : string * System.Threading.CancellationToken -> Azure.Response<byte[]>
override this.BackupSecret : string * System.Threading.CancellationToken -> Azure.Response<byte[]>
Public Overridable Function BackupSecret (name As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of Byte())

Parameters

name
String

The name of the secret.

cancellationToken
CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Exceptions

name is an empty string.

name is null.

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.

Applies to