SecretClient.BackupSecret(String, CancellationToken) Method

Reference

Definition

Namespace:: Azure.Security.KeyVault.Secrets

Assembly:: Azure.Security.KeyVault.Secrets.dll

Package:: Azure.Security.KeyVault.Secrets v4.7.0

Package:: Azure.Security.KeyVault.Secrets v4.6.0-beta.2

Source:: SecretClient.cs

Source:: SecretClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

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.

Applies to

Share via