KeyVaultBackupClient.StartBackupAsync(Uri, String, CancellationToken) Method

Definition

Namespace:

Azure.Security.KeyVault.Administration

Assembly:

Azure.Security.KeyVault.Administration.dll

Package:

Azure.Security.KeyVault.Administration v4.5.0

Source:

KeyVaultBackupClient.cs

Initiates a full key backup of the Key Vault.

public virtual System.Threading.Tasks.Task<Azure.Security.KeyVault.Administration.KeyVaultBackupOperation> StartBackupAsync (Uri blobStorageUri, string sasToken = default, System.Threading.CancellationToken cancellationToken = default);

abstract member StartBackupAsync : Uri * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Administration.KeyVaultBackupOperation>
override this.StartBackupAsync : Uri * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Administration.KeyVaultBackupOperation>

Public Overridable Function StartBackupAsync (blobStorageUri As Uri, Optional sasToken As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of KeyVaultBackupOperation)

Parameters

blobStorageUri

Uri

The Uri for the blob storage resource.

sasToken

String

Optional Shared Access Signature (SAS) token to authorize access to the blob. If null, Managed Identity will be used to authenticate instead.

cancellationToken

CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Task<KeyVaultBackupOperation>

A KeyVaultBackupOperation to wait on this long-running operation.

Exceptions

ArgumentNullException

blobStorageUri or sasToken is null.

RequestFailedException

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