ClientEncryptionDeleteKeyAsync Method

Removes the key document with the given UUID (BSON binary subtype 0x04) from the key vault collection.

Namespace: MongoDB.Driver.Encryption
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2

Syntax

Copy

public Task<DeleteResult> DeleteKeyAsync(
	Guid id,
	CancellationToken cancellationToken = null
)

Public Function DeleteKeyAsync ( 
	id As Guid,
	Optional cancellationToken As CancellationToken = Nothing
) As Task(Of DeleteResult)

member DeleteKeyAsync : 
        id : Guid * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<DeleteResult>

Parameters

id: Type: SystemGuid
The id.
cancellationToken (Optional): Type: System.ThreadingCancellationToken
The cancellation token.

Return Value

Type: TaskDeleteResult
Returns the result of the internal deleteOne() operation on the key vault collection.

Reference

ClientEncryption Class

MongoDB.Driver.Encryption Namespace

ClientEncryptionAddLanguageSpecificTextSet("LST425F8BA_0?cpp=::|nu=.");DeleteKeyAsync Method

Parameters

Return Value

Reference

ClientEncryptionDeleteKeyAsync Method