SqlColumnEncryptionAzureKeyVaultProvider.DecryptColumnEncryptionKeyAsync Method

Definition

Namespace:: Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider

Assembly:: Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider.dll

Package:: Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider v7.1.0

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.

Asynchronously uses the asymmetric key specified by the key path and decrypts an encrypted CEK with the RSA encryption algorithm.

public override System.Threading.Tasks.Task<byte[]> DecryptColumnEncryptionKeyAsync(string masterKeyPath, string encryptionAlgorithm, byte[] encryptedColumnEncryptionKey, System.Threading.CancellationToken cancellationToken = default);

override this.DecryptColumnEncryptionKeyAsync : string * string * byte[] * System.Threading.CancellationToken -> System.Threading.Tasks.Task<byte[]>

Public Overrides Function DecryptColumnEncryptionKeyAsync (masterKeyPath As String, encryptionAlgorithm As String, encryptedColumnEncryptionKey As Byte(), Optional cancellationToken As CancellationToken = Nothing) As Task(Of Byte())

Parameters

masterKeyPath: String

Complete path of an asymmetric key in Azure Key Vault

encryptionAlgorithm: String

Asymmetric Key Encryption Algorithm

encryptedColumnEncryptionKey: Byte[]

Encrypted Column Encryption Key

cancellationToken: CancellationToken

Token used to request cancellation of the operation

Returns

Task<Byte[]>

Plain text column encryption key

Remarks

Argument validation failures are reported through the returned task rather than thrown synchronously.

Applies to