CryptographyClient.UnwrapKey Method

Reference

Definition

Namespace:: Azure.Security.KeyVault.Keys.Cryptography

Assembly:: Azure.Security.KeyVault.Keys.dll

Package:: Azure.Security.KeyVault.Keys v4.7.0

Package:: Azure.Security.KeyVault.Keys v4.6.0-beta.2

Source:: CryptographyClient.cs

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

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.