ClientEncryptionAddAlternateKeyNameAsync 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.17.0+b316340e6cc3a8bfc8638dc31b54fbbfe41bfcb2

Syntax

Copy

public Task<BsonDocument> AddAlternateKeyNameAsync(
	Guid id,
	string alternateKeyName,
	CancellationToken cancellationToken = default
)

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

member AddAlternateKeyNameAsync : 
        id : Guid * 
        alternateKeyName : string * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<BsonDocument>

Parameters

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

Return Value

Type: TaskBsonDocument
Returns the previous version of the key document.

Reference

ClientEncryption Class

MongoDB.Driver.Encryption Namespace

ClientEncryptionAddLanguageSpecificTextSet("LST165F361B_0?cpp=::|nu=.");AddAlternateKeyNameAsync Method

Parameters

Return Value

Reference

ClientEncryptionAddAlternateKeyNameAsync Method