KeyVaultClientExtensions.UnwrapKeyAsync Method

Definition

Overloads

UnwrapKeyAsync(IKeyVaultClient, String, String, Byte[], CancellationToken)

Unwraps a symmetric key using the specified key in the vault that has initially been used for wrapping the key.

UnwrapKeyAsync(IKeyVaultClient, String, String, String, String, Byte[], CancellationToken)

Unwraps a symmetric key using the specified key that was initially used for wrapping that key.

UnwrapKeyAsync(IKeyVaultClient, String, String, Byte[], CancellationToken)

Unwraps a symmetric key using the specified key in the vault that has initially been used for wrapping the key.

public static System.Threading.Tasks.Task<Microsoft.Azure.KeyVault.Models.KeyOperationResult> UnwrapKeyAsync (this Microsoft.Azure.KeyVault.IKeyVaultClient operations, string keyIdentifier, string algorithm, byte[] wrappedKey, System.Threading.CancellationToken cancellationToken = null);
static member UnwrapKeyAsync : Microsoft.Azure.KeyVault.IKeyVaultClient * string * string * byte[] * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.KeyVault.Models.KeyOperationResult>

Parameters

operations
IKeyVaultClient
keyIdentifier
String

The global key identifier of the wrapping/unwrapping key

algorithm
String

The unwrap algorithm. For more information on possible algorithm types, see JsonWebKeySignatureAlgorithm.

wrappedKey
Byte[]

The wrapped symmetric key

cancellationToken
CancellationToken

Optional cancellation token

Returns

Task<KeyOperationResult>

The unwrapped symmetric key

Applies to

Product Introduced

UnwrapKeyAsync(IKeyVaultClient, String, String, String, String, Byte[], CancellationToken)

Unwraps a symmetric key using the specified key that was initially used for wrapping that key.

public static System.Threading.Tasks.Task<Microsoft.Azure.KeyVault.Models.KeyOperationResult> UnwrapKeyAsync (this Microsoft.Azure.KeyVault.IKeyVaultClient operations, string vaultBaseUrl, string keyName, string keyVersion, string algorithm, byte[] value, System.Threading.CancellationToken cancellationToken = null);
static member UnwrapKeyAsync : Microsoft.Azure.KeyVault.IKeyVaultClient * string * string * string * string * byte[] * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.KeyVault.Models.KeyOperationResult>

Parameters

operations
IKeyVaultClient

The operations group for this extension method.

vaultBaseUrl
String

The vault name, for example https://myvault.vault.azure.net.

keyName
String

The name of the key.

keyVersion
String

The version of the key.

algorithm
String

algorithm identifier. Possible values include: 'RSA-OAEP', 'RSA-OAEP-256', 'RSA1_5'

value
Byte[]
cancellationToken
CancellationToken

The cancellation token.

Returns

Task<KeyOperationResult>

Remarks

The UNWRAP operation supports decryption of a symmetric key using the

target key encryption key. This operation is the reverse of the WRAP

operation. The UNWRAP operation applies to asymmetric and symmetric keys

stored in Azure Key Vault since it uses the private portion of the key.

Applies to

Product Introduced