ClientEncryptionRemoveAlternateKeyNameAsync Method

Removes an alternateKeyName from 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.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2

Syntax

Copy

public Task<BsonDocument> RemoveAlternateKeyNameAsync(
	Guid id,
	string alternateKeyName,
	CancellationToken cancellationToken = null
)

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

member RemoveAlternateKeyNameAsync : 
        id : Guid * 
        alternateKeyName : string * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<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: TaskBsonDocument
Returns the previous version of the key document.

Reference

ClientEncryption Class

MongoDB.Driver.Encryption Namespace

ClientEncryptionAddLanguageSpecificTextSet("LSTF8DE30E6_0?cpp=::|nu=.");RemoveAlternateKeyNameAsync Method

Parameters

Return Value

Reference

ClientEncryptionRemoveAlternateKeyNameAsync Method