CryptographyClient.SecureUnwrapKeyAsync Method

Definition

Namespace:

Azure.Security.KeyVault.Keys.Cryptography

Assembly:

Azure.Security.KeyVault.Keys.dll

Package:

Azure.Security.KeyVault.Keys v4.11.0-beta.3

Source:

CryptographyClient.cs

Unwraps the specified wrapped key using secure unwrap.

public virtual System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.Cryptography.SecureUnwrapResult> SecureUnwrapKeyAsync(Azure.Security.KeyVault.Keys.Cryptography.SecureKeyWrapAlgorithm algorithm, byte[] encryptedKey, string targetAttestationToken, System.Threading.CancellationToken cancellationToken = default);

abstract member SecureUnwrapKeyAsync : Azure.Security.KeyVault.Keys.Cryptography.SecureKeyWrapAlgorithm * byte[] * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.Cryptography.SecureUnwrapResult>
override this.SecureUnwrapKeyAsync : Azure.Security.KeyVault.Keys.Cryptography.SecureKeyWrapAlgorithm * byte[] * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.Cryptography.SecureUnwrapResult>

Public Overridable Function SecureUnwrapKeyAsync (algorithm As SecureKeyWrapAlgorithm, encryptedKey As Byte(), targetAttestationToken As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of SecureUnwrapResult)

Parameters

algorithm

SecureKeyWrapAlgorithm

The SecureKeyWrapAlgorithm to use.

encryptedKey

Byte[]

The encrypted key bytes to unwrap.

targetAttestationToken

String

The target attestation token for the unwrap operation.

cancellationToken

CancellationToken

A CancellationToken to cancel the operation.

Returns

Task<SecureUnwrapResult>

The result of the unwrap operation. The returned SecureUnwrapResult contains the unwrapped key along with all other information needed to identify it. This information should be stored with the unwrapped key.

Exceptions

ArgumentException

The specified algorithm does not match the key corresponding to the key identifier.

CryptographicException

The local cryptographic provider threw an exception.

InvalidOperationException

The key is invalid for the current operation.

NotSupportedException

The operation is not supported with the specified key.

RequestFailedException

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