MongoDBBuilderExtensions

Docs/Reference/Search C# APIs/Aspire.Hosting.MongoDB/MongoDBBuilderExtensions

MongoDBBuilderExtensions

Docs Reference Search C# APIs Aspire.Hosting.MongoDB MongoDBBuilderExtensions

Classstaticnet10.0

📦 Aspire.Hosting.MongoDB v13.6.0

Provides extension methods for adding MongoDB resources to an Hosting.IDistributedApplicationBuilder.

namespace Aspire.Hosting;

public static class MongoDBBuilderExtensions
{
    // ...
}

Source

Search members of MongoDBBuilderExtensions...

15 members

Clear filtersReset all

Methods15

AddDatabase(IResourceBuilder<MongoDBServerResource>, string, string?)extensionats export

IResourceBuilder<MongoDBDatabaseResource>

Adds a MongoDB database to the application model.

AddMongoDB(IDistributedApplicationBuilder, string, int?)extensionats ignored

IResourceBuilder<MongoDBServerResource>

Adds a MongoDB resource to the application model. A container is used for local development.

AddMongoDB(IDistributedApplicationBuilder, string, int?, IResourceBuilder<ParameterResource>, IResourceBuilder<ParameterResource>)extensionats export

IResourceBuilder<MongoDBServerResource>

WithBindIpAll(IResourceBuilder<MongoDBServerResource>)extensionexperimentalats export

IResourceBuilder<MongoDBServerResource>

Configures the MongoDB server to bind to and listen on all network interfaces.

WithDataBindMount(IResourceBuilder<MongoDBServerResource>, string, bool)extensionats export

IResourceBuilder<MongoDBServerResource>

Adds a bind mount for the data folder to a MongoDB container resource.

WithDataVolume(IResourceBuilder<MongoDBServerResource>, string?, bool)extensionats export

IResourceBuilder<MongoDBServerResource>

Adds a named volume for the data folder to a MongoDB container resource.

WithHostPort(IResourceBuilder<MongoExpressContainerResource>, int?)extensionats export

IResourceBuilder<MongoExpressContainerResource>

Configures the host port that the Mongo Express resource is exposed on instead of using randomly assigned port.

WithInitBindMount(IResourceBuilder<MongoDBServerResource>, string, bool)extensionobsoleteats ignored

IResourceBuilder<MongoDBServerResource>

Adds a bind mount for the init folder to a MongoDB container resource.

WithInitFiles(IResourceBuilder<MongoDBServerResource>, string)extensionats export

IResourceBuilder<MongoDBServerResource>

Copies init files into a MongoDB container resource.

WithKeyFile(IResourceBuilder<MongoDBServerResource>, IExpressionValue, string)extensionexperimentalats export

IResourceBuilder<MongoDBServerResource>

Sets up a keyfile for internal authentication between members of a MongoDB replica set, with the specified keyValue as the content of the file.

WithMongoExpress(IResourceBuilder<T>, Action<IResourceBuilder<MongoExpressContainerResource>>, string?)extensionats export

IResourceBuilder<T>

Adds a MongoExpress administration and development platform for MongoDB to the application model.

WithRepl(IResourceBuilder<MongoDBServerResource>)extensionats export

IResourceBuilder<MongoDBServerResource>

Adds a REPL command that opens an authenticated MongoDB shell in the dashboard terminal dock.

WithReplicaSet(IResourceBuilder<MongoDBServerResource>, string?)extensionexperimentalats export

IResourceBuilder<MongoDBServerResource>

Configures and initializes the MongoDB server as a single-member replica set for local development.

WithTlsAllowInvalidCertificates(IResourceBuilder<MongoDBServerResource>)extensionexperimentalats export

IResourceBuilder<MongoDBServerResource>

Configures the MongoDB server to accept TLS connections whose peer certificate cannot be validated, by passing --tlsAllowInvalidCertificates to mongod.

WithTlsMode(IResourceBuilder<MongoDBServerResource>, MongoDBTlsMode)extensionexperimentalats export

IResourceBuilder<MongoDBServerResource>

Configures the --tlsMode the MongoDB server is started with when TLS is active.

View all methods