ClientEncryptionGetKeyByAlternateKeyNameAsync Method

Finds a single key document with the given UUID (BSON binary subtype 0x04).

Namespace: MongoDB.Driver.Encryption
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2

Syntax

Copy

public Task<BsonDocument> GetKeyByAlternateKeyNameAsync(
	string alternateKeyName,
	CancellationToken cancellationToken = null
)

Public Function GetKeyByAlternateKeyNameAsync ( 
	alternateKeyName As String,
	Optional cancellationToken As CancellationToken = Nothing
) As Task(Of BsonDocument)

member GetKeyByAlternateKeyNameAsync : 
        alternateKeyName : string * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<BsonDocument>

Parameters

alternateKeyName: Type: SystemString
The alternate key name.
cancellationToken (Optional): Type: System.ThreadingCancellationToken
The cancellation token.

Return Value

Type: TaskBsonDocument
Returns a key document in the key vault collection with the given alternateKeyName.

Reference

ClientEncryption Class

MongoDB.Driver.Encryption Namespace

ClientEncryptionAddLanguageSpecificTextSet("LST6121A338_0?cpp=::|nu=.");GetKeyByAlternateKeyNameAsync Method

Parameters

Return Value

Reference

ClientEncryptionGetKeyByAlternateKeyNameAsync Method