Click or drag to resize

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.17.0+b316340e6cc3a8bfc8638dc31b54fbbfe41bfcb2
Syntax
public Task<BsonDocument> RemoveAlternateKeyNameAsync(
	Guid id,
	string alternateKeyName,
	CancellationToken cancellationToken = default
)

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.
See Also