KeyVaultBackupClient.StartSelectiveKeyRestore Method

Reference

Definition

Namespace:: Azure.Security.KeyVault.Administration

Assembly:: Azure.Security.KeyVault.Administration.dll

Package:: Azure.Security.KeyVault.Administration v4.4.0

Package:: Azure.Security.KeyVault.Administration v4.4.0-beta.2

Source:: KeyVaultBackupClient.cs

Source:: KeyVaultBackupClient.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.

Initiates a selective key restore of the Key Vault.

public virtual Azure.Security.KeyVault.Administration.KeyVaultSelectiveKeyRestoreOperation StartSelectiveKeyRestore (string keyName, Uri folderUri, string sasToken = default, System.Threading.CancellationToken cancellationToken = default);

abstract member StartSelectiveKeyRestore : string * Uri * string * System.Threading.CancellationToken -> Azure.Security.KeyVault.Administration.KeyVaultSelectiveKeyRestoreOperation
override this.StartSelectiveKeyRestore : string * Uri * string * System.Threading.CancellationToken -> Azure.Security.KeyVault.Administration.KeyVaultSelectiveKeyRestoreOperation

Public Overridable Function StartSelectiveKeyRestore (keyName As String, folderUri As Uri, Optional sasToken As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As KeyVaultSelectiveKeyRestoreOperation

Parameters

keyName: String

The name of the key to be restored from the supplied backup.

folderUri: Uri

The Uri for the blob storage resource, including the path to the blob container where the backup resides. This would be the exact value that is returned as the result of a KeyVaultBackupOperation. An example Uri path may look like the following: https://contoso.blob.core.windows.net/backup/mhsm-contoso-2020090117323313.

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

KeyVaultSelectiveKeyRestoreOperation

A KeyVaultSelectiveKeyRestoreOperation to wait on this long-running operation.

Exceptions

ArgumentNullException

folderUri or sasToken is null.

RequestFailedException

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

Applies to