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

Encrypts the specified key.

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

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

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

Parameters

algorithm: KeyWrapAlgorithm

The KeyWrapAlgorithm to use.

key: Byte[]

The key to encrypt.

cancellationToken: CancellationToken

A CancellationToken to cancel the operation.

Returns

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.