CertificateClient.BackupCertificateAsync(String, CancellationToken) Method

Definition

Namespace:

Azure.Security.KeyVault.Certificates

Assembly:

Azure.Security.KeyVault.Certificates.dll

Package:

Azure.Security.KeyVault.Certificates v4.6.0

Source:

CertificateClient.cs

Creates a backup of the certificate, including all versions, which can be used to restore the certificate to the state at the time of the backup in the case the certificate is deleted, or to restore the certificate to a different vault in the same region as the original value. This operation requires the certificate/backup permission.

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

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

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

Parameters

certificateName

String

The name of the KeyVaultCertificate to backup.

cancellationToken

CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Task<Response<Byte[]>>

The certificate backup.

Exceptions

ArgumentException

certificateName is empty.

ArgumentNullException

certificateName is null.