SqlColumnEncryptionKeyStoreProvider.EncryptColumnEncryptionKeyAsync Méthode

Définition

Espace de noms:

Microsoft.Data.SqlClient

Assembly:

Microsoft.Data.SqlClient.dll

Package:

Microsoft.Data.SqlClient v7.1.0

Chiffre de façon asynchrone une clé de chiffrement de colonne à l’aide de la clé principale de colonne avec le chemin de clé spécifié et l’algorithme spécifié.

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())

Paramètres

masterKeyPath

String

Chemin de la clé principale de colonne. Le format de chemin est spécifique à l’implémentation du fournisseur de magasin de clés (par exemple, une empreinte numérique pour le magasin de certificats ou une URL d’identificateur de clé pour Azure Key Vault).

encryptionAlgorithm

String

Nom de l’algorithme de chiffrement. Par exemple : RSA_OAEP.

columnEncryptionKey

Byte[]

Clé de chiffrement de colonne à chiffrer.

cancellationToken

CancellationToken

Jeton pour annuler l’opération asynchrone.

Retours

Task<Byte[]>

Tâche qui retourne un Byte tableau représentant la clé de chiffrement de colonne chiffrée à l’achèvement.

Remarques

L’implémentation par défaut vérifie d’abord la cancellationToken tâche annulée et retourne une tâche annulée si l’annulation a été demandée. Sinon, il appelle la méthode synchrone EncryptColumnEncryptionKey(String, String, Byte[]) et encapsule le résultat dans une tâche terminée. Si la méthode synchrone lève, l’exception est interceptée et une tâche défectueuse est retournée plutôt que de lever de façon synchrone.

Les classes dérivées qui effectuent des E/S (telles que les appels à Azure Key Vault) doivent remplacer cette méthode par une implémentation véritablement asynchrone qui respecte le jeton d’annulation.