KeyVaultClientExtensions.UnwrapKeyAsync Method (KeyVaultClient, KeyBundle, Byte[], String)

 

Asynchronously unwraps a symmetric key using the specified wrapping key and algorithm.

Namespace:   Microsoft.Azure.KeyVault
Assembly:  Microsoft.Azure.KeyVault (in Microsoft.Azure.KeyVault.dll)

Syntax

public static Task<KeyOperationResult> UnwrapKeyAsync(
    this KeyVaultClient client,
    KeyBundle wrappingKey,
    byte[] wrappedKey,
    string algorithm
)

public:
[ExtensionAttribute]
static Task<KeyOperationResult^>^ UnwrapKeyAsync(
    KeyVaultClient^ client,
    KeyBundle^ wrappingKey,
    array<unsigned char>^ wrappedKey,
    String^ algorithm
)

static member UnwrapKeyAsync : 
        client:KeyVaultClient *
        wrappingKey:KeyBundle *
        wrappedKey:byte[] *
        algorithm:string -> Task<KeyOperationResult>

<ExtensionAttribute>
Public Shared Function UnwrapKeyAsync (
    client As KeyVaultClient,
    wrappingKey As KeyBundle,
    wrappedKey As Byte(),
    algorithm As String
) As Task(Of KeyOperationResult)

Parameters

• client
  Type: Microsoft.Azure.KeyVault.KeyVaultClient

  The application, rather than the server application, that initiates a connection to a server.

• wrappingKey
  Type: Microsoft.Azure.KeyVault.KeyBundle

  The wrapping key.

• wrappedKey
  Type: System.Byte[]

  The symmetric key to unwrap.

• algorithm
  Type: System.String

  The algorithm to use. For more information on possible algorithm types, see JsonWebKeyEncryptionAlgorithm.

Return Value

Type: System.Threading.Tasks.Task<KeyOperationResult>

The unwrapped key.

See Also

UnwrapKeyAsync Overload
KeyVaultClientExtensions Class
Microsoft.Azure.KeyVault Namespace

Return to top