CryptographyClient.UnwrapKey Method

Definition

Namespace:

Azure.Security.KeyVault.Keys.Cryptography

Assembly:

Azure.Security.KeyVault.Keys.dll

Package:

Azure.Security.KeyVault.Keys v4.6.0

Source:

CryptographyClient.cs

Decrypts the specified encrypted key.

public virtual Azure.Security.KeyVault.Keys.Cryptography.UnwrapResult UnwrapKey (Azure.Security.KeyVault.Keys.Cryptography.KeyWrapAlgorithm algorithm, byte[] encryptedKey, System.Threading.CancellationToken cancellationToken = default);

abstract member UnwrapKey : Azure.Security.KeyVault.Keys.Cryptography.KeyWrapAlgorithm * byte[] * System.Threading.CancellationToken -> Azure.Security.KeyVault.Keys.Cryptography.UnwrapResult
override this.UnwrapKey : Azure.Security.KeyVault.Keys.Cryptography.KeyWrapAlgorithm * byte[] * System.Threading.CancellationToken -> Azure.Security.KeyVault.Keys.Cryptography.UnwrapResult

Public Overridable Function UnwrapKey (algorithm As KeyWrapAlgorithm, encryptedKey As Byte(), Optional cancellationToken As CancellationToken = Nothing) As UnwrapResult

Parameters

algorithm

KeyWrapAlgorithm

The KeyWrapAlgorithm to use.

encryptedKey

Byte[]

The encrypted key.

cancellationToken

CancellationToken

A CancellationToken to cancel the operation.

Returns

UnwrapResult

The result of the unwrap operation. The returned UnwrapResult contains the key along with information regarding the algorithm and key used to unwrap it.

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.