Click or drag to resize

ClientEncryptionGetKeyByAlternateKeyName Method

Finds a single key document with the given alter name.

Namespace:  MongoDB.Driver.Encryption
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.19.1+3a2a09dd959482f665ffbb5df2557ec541597af4
Syntax
public BsonDocument GetKeyByAlternateKeyName(
	string alternateKeyName,
	CancellationToken cancellationToken = default
)

Parameters

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

Return Value

Type: BsonDocument
Returns a key document in the key vault collection with the given alternateKeyName.
See Also