ClientEncryptionAddAlternateKeyName Method |
Adds an alternate key name to the keyAltNames array of the key document in the key vault collection 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 BsonDocument AddAlternateKeyName(
Guid id,
string alternateKeyName,
CancellationToken cancellationToken = default
)
Public Function AddAlternateKeyName (
id As Guid,
alternateKeyName As String,
Optional cancellationToken As CancellationToken = Nothing
) As BsonDocument
member AddAlternateKeyName :
id : Guid *
alternateKeyName : string *
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> BsonDocument
Parameters
- id
- Type: SystemGuid
The id. - alternateKeyName
- Type: SystemString
The alternate key name. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Return Value
Type:
BsonDocumentReturns the previous version of the key document.
See Also