SqlColumnEncryptionKeyStoreProvider.EncryptColumnEncryptionKeyAsync Метод

Определение

Пространство имен:

Microsoft.Data.SqlClient

Сборка:

Microsoft.Data.SqlClient.dll

Пакет:

Microsoft.Data.SqlClient v7.1.0

Асинхронно шифрует ключ шифрования столбца с помощью главного ключа столбца с указанным путем ключа и с помощью указанного алгоритма.

public virtual System.Threading.Tasks.Task<byte[]> EncryptColumnEncryptionKeyAsync(string masterKeyPath, string encryptionAlgorithm, byte[] columnEncryptionKey, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function EncryptColumnEncryptionKeyAsync (masterKeyPath As String, encryptionAlgorithm As String, columnEncryptionKey As Byte(), Optional cancellationToken As CancellationToken = Nothing) As Task(Of Byte())

Параметры

masterKeyPath

String

Путь главного ключа столбца. Формат пути зависит от реализации поставщика хранилища ключей (например, отпечаток для хранилища сертификатов или URL-адрес идентификатора ключа для Azure Key Vault).

encryptionAlgorithm

String

Имя алгоритма шифрования. Например: RSA_OAEP.

columnEncryptionKey

Byte[]

Ключ шифрования столбца для шифрования.

cancellationToken

CancellationToken

Маркер для отмены асинхронной операции.

Возвращаемое значение

Task<Byte[]>

Задача, возвращающая Byte массив, представляющий ключ шифрования зашифрованного столбца при завершении.

Комментарии

Реализация по умолчанию сначала проверяет cancellationToken и возвращает отмененную задачу при запросе отмены. В противном случае вызывает синхронный EncryptColumnEncryptionKey(String, String, Byte[]) метод и упаковывает результат в завершенную задачу. Если вызывается синхронный метод, исключение перехватывается и возвращается неисправная задача, а не синхронно.

Производные классы, выполняющие операции ввода-вывода (например, вызовы к Azure Key Vault), должны переопределить этот метод с действительно асинхронной реализацией, которая учитывает маркер отмены.