KeyVaultClient.WrapKeyAsync Method (String, String, Byte[], CancellationToken)

 

Asynchronously wraps a symmetric key using the specified key.

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

Syntax

public Task<KeyOperationResult> WrapKeyAsync(
    string keyIdentifier,
    string algorithm,
    byte[] key,
    CancellationToken cancellationToken = null
)

public:
Task<KeyOperationResult^>^ WrapKeyAsync(
    String^ keyIdentifier,
    String^ algorithm,
    array<unsigned char>^ key,
    CancellationToken cancellationToken = null
)

member WrapKeyAsync : 
        keyIdentifier:string *
        algorithm:string *
        key:byte[] *
        cancellationToken:CancellationToken = null -> Task<KeyOperationResult>

Public Function WrapKeyAsync (
    keyIdentifier As String,
    algorithm As String,
    key As Byte(),
    cancellationToken As CancellationToken
) As Task(Of KeyOperationResult)

Parameters

• keyIdentifier
  Type: System.String

  The global key identifier of the key used for wrapping.

• algorithm
  Type: System.String

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

• key
  Type: System.Byte[]

  The symmetric key.

• cancellationToken
  Type: System.Threading.CancellationToken

  Optional cancellation token.

Return Value

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

The wrapped symmetric key.

See Also

WrapKeyAsync Overload
KeyVaultClient Class
Microsoft.Azure.KeyVault Namespace

Return to top