ClientEncryption Class

Explicit client encryption.

Inheritance Hierarchy

SystemObject
MongoDB.Driver.EncryptionClientEncryption

Namespace: MongoDB.Driver.Encryption
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.22.0+75246110ed1247226fcc7f8eb2c54ffab745693e

Syntax

Copy

public sealed class ClientEncryption : IDisposable

Public NotInheritable Class ClientEncryption
	Implements IDisposable

[<SealedAttribute>]
type ClientEncryption =  
    class
        interface IDisposable
    end

The ClientEncryption type exposes the following members.

Constructors

	Name	Description
	ClientEncryption	Initializes a new instance of the ClientEncryption class.

Top

Methods

	Name	Description
	AddAlternateKeyName	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).
	AddAlternateKeyNameAsync	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).
	CreateDataKey	An alias function equivalent to createKey.
	CreateDataKeyAsync	An alias function equivalent to createKey.
	CreateEncryptedCollection(IMongoDatabase, String, CreateCollectionOptions, String, BsonDocument, CancellationToken)	Create encrypted collection.
	CreateEncryptedCollection(IMongoDatabase, String, CreateCollectionOptions, String, DataKeyOptions, CancellationToken)	Obsolete. Create encrypted collection.
	CreateEncryptedCollectionAsync(IMongoDatabase, String, CreateCollectionOptions, String, BsonDocument, CancellationToken)	Create encrypted collection.
	CreateEncryptedCollectionAsync(IMongoDatabase, String, CreateCollectionOptions, String, DataKeyOptions, CancellationToken)	Obsolete. Create encrypted collection.
	Decrypt	Decrypts the specified value.
	DecryptAsync	Decrypts the specified value.
	DeleteKey	Removes the key document with the given UUID (BSON binary subtype 0x04) from the key vault collection.
	DeleteKeyAsync	Removes the key document with the given UUID (BSON binary subtype 0x04) from the key vault collection.
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
	Encrypt	Encrypts the specified value.
	EncryptAsync	Encrypts the specified value.
	EncryptExpression	Encrypts a Match Expression or Aggregate Expression to query a range index.
	EncryptExpressionAsync	Encrypts a Match Expression or Aggregate Expression to query a range index.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetKey	Finds a single key document with the given UUID (BSON binary subtype 0x04).
	GetKeyAsync	Finds a single key document with the given UUID (BSON binary subtype 0x04).
	GetKeyByAlternateKeyName	Finds a single key document with the given alter name.
	GetKeyByAlternateKeyNameAsync	Finds a single key document with the given UUID (BSON binary subtype 0x04).
	GetKeys	Finds all documents in the key vault collection.
	GetKeysAsync	Finds all documents in the key vault collection.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	RemoveAlternateKeyName	Removes an alternateKeyName from the keyAltNames array of the key document in the key vault collection with the given UUID (BSON binary subtype 0x04).
	RemoveAlternateKeyNameAsync	Removes an alternateKeyName from the keyAltNames array of the key document in the key vault collection with the given UUID (BSON binary subtype 0x04).
	RewrapManyDataKey	Decrypts multiple data keys and (re-)encrypts them with a new masterKey, or with their current masterKey if a new one is not given.
	RewrapManyDataKeyAsync	Decrypts multiple data keys and (re-)encrypts them with a new masterKey, or with their current masterKey if a new one is not given.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Extension Methods

	Name	Description
	ToBson	Serializes an object to a BSON byte array. (Defined by BsonExtensionMethods.)
	ToBsonDocument	Serializes an object to a BsonDocument. (Defined by BsonExtensionMethods.)
	ToJson	Serializes an object to a JSON string. (Defined by BsonExtensionMethods.)

Top

Reference

MongoDB.Driver.Encryption Namespace