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.19.1+3a2a09dd959482f665ffbb5df2557ec541597af4
Syntax public Task<BsonDocument> GetKeyByAlternateKeyNameAsync(
string alternateKeyName,
CancellationToken cancellationToken = default
)
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 new CancellationToken()
*)
-> Task<BsonDocument>
Parameters
- alternateKeyName
- Type: SystemString
The alternate key name. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Return Value
Type:
TaskBsonDocumentReturns a key document in the key vault collection with the given alternateKeyName.
See Also