CryptographyClient.WrapKeyAsync 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

Encrypts the specified key.

public virtual System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.Cryptography.WrapResult> WrapKeyAsync (Azure.Security.KeyVault.Keys.Cryptography.KeyWrapAlgorithm algorithm, byte[] key, System.Threading.CancellationToken cancellationToken = default);

abstract member WrapKeyAsync : Azure.Security.KeyVault.Keys.Cryptography.KeyWrapAlgorithm * byte[] * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.Cryptography.WrapResult>
override this.WrapKeyAsync : Azure.Security.KeyVault.Keys.Cryptography.KeyWrapAlgorithm * byte[] * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.Cryptography.WrapResult>

Public Overridable Function WrapKeyAsync (algorithm As KeyWrapAlgorithm, key As Byte(), Optional cancellationToken As CancellationToken = Nothing) As Task(Of WrapResult)

Parameters

algorithm

KeyWrapAlgorithm

The KeyWrapAlgorithm to use.

key

Byte[]

The key to encrypt.

cancellationToken

CancellationToken

A CancellationToken to cancel the operation.

Returns

Task<WrapResult>

The result of the wrap operation. The returned WrapResult contains the wrapped key along with all other information needed to unwrap it. This information should be stored with the wrapped key.

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.