Aspire.Hosting.MongoDB 13.0.0
Aspire.Hosting.MongoDB library
Provides extension methods and resource definitions for an Aspire AppHost to configure a MongoDB resource.
Getting started
Install the package
In your AppHost project, install the Aspire MongoDB Hosting library with NuGet:
dotnet add package Aspire.Hosting.MongoDB
Usage example
Then, in the AppHost.cs file of AppHost, add a MongoDB resource and consume the connection using the following methods:
var db = builder.AddMongoDB("mongodb").AddDatabase("mydb");
var myService = builder.AddProject<Projects.MyService>()
.WithReference(db);
Connection Properties
When you reference a MongoDB resource using WithReference, the following connection properties are made available to the consuming project:
MongoDB server
The MongoDB server resource exposes the following connection properties:
| Property Name | Description |
|---|---|
Host |
The hostname or IP address of the MongoDB server |
Port |
The port number the MongoDB server is listening on |
Username |
The username for authentication |
Password |
The password for authentication (available when a password parameter is configured) |
AuthenticationDatabase |
The authentication database (available when a password parameter is configured) |
AuthenticationMechanism |
The authentication mechanism (available when a password parameter is configured) |
Uri |
The connection URI, with the format mongodb://{Username}:{Password}@{Host}:{Port}/?authSource={AuthenticationDatabase}&authMechanism={AuthenticationMechanism} |
MongoDB database
The MongoDB database resource combines the server properties above and adds the following connection property:
| Property Name | Description |
|---|---|
Database |
The MongoDB database name |
Aspire exposes each property as an environment variable named [RESOURCE]_[PROPERTY]. For instance, the Uri property of a resource called db1 becomes DB1_URI.
Additional documentation
Feedback & contributing
No packages depend on Aspire.Hosting.MongoDB.
.NET 8.0
- Aspire.Hosting (>= 13.0.0)
- System.IO.Hashing (>= 9.0.10)
- StreamJsonRpc (>= 2.22.23)
- Semver (>= 3.0.0)
- Polly.Core (>= 8.6.4)
- Newtonsoft.Json (>= 13.0.4)
- MongoDB.Driver (>= 3.5.0)
- Microsoft.Extensions.Primitives (>= 8.0.0)
- Microsoft.Extensions.Options (>= 8.0.2)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.3)
- Microsoft.Extensions.Http (>= 8.0.1)
- Microsoft.Extensions.Hosting.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Hosting (>= 8.0.1)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.22)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.Configuration.Abstractions (>= 8.0.0)
- KubernetesClient (>= 18.0.5)
- JsonPatch.Net (>= 3.3.0)
- Humanizer.Core (>= 2.14.1)
- Grpc.Tools (>= 2.72.0)
- Grpc.Net.ClientFactory (>= 2.71.0)
- Grpc.AspNetCore (>= 2.71.0)
- Google.Protobuf (>= 3.33.0)
- DnsClient (>= 1.8.0)
- AspNetCore.HealthChecks.Uris (>= 9.0.0)
- AspNetCore.HealthChecks.MongoDb (>= 9.0.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.2)
| Version | Downloads | Last updated |
|---|---|---|
| 13.0.1 | 0 | 11/26/2025 |
| 13.0.0 | 3 | 11/19/2025 |
| 9.5.2 | 7 | 10/25/2025 |
| 9.5.1 | 8 | 10/11/2025 |
| 9.5.0 | 11 | 09/27/2025 |
| 9.4.2 | 13 | 09/06/2025 |
| 9.4.1 | 17 | 08/16/2025 |
| 9.4.0 | 17 | 08/02/2025 |
| 9.3.1 | 24 | 06/20/2025 |
| 9.3.0 | 22 | 06/04/2025 |
| 9.2.1 | 22 | 06/05/2025 |
| 9.2.0 | 23 | 06/05/2025 |
| 9.1.0 | 24 | 06/05/2025 |
| 9.0.0 | 21 | 06/05/2025 |
| 9.0.0-rc.1.24511.1 | 22 | 06/04/2025 |
| 8.2.2 | 22 | 06/05/2025 |
| 8.2.1 | 21 | 06/05/2025 |
| 8.2.0 | 25 | 06/05/2025 |
| 8.1.0 | 24 | 06/05/2025 |
| 8.0.2 | 21 | 06/05/2025 |
| 8.0.1 | 20 | 06/05/2025 |
| 8.0.0 | 22 | 06/05/2025 |
| 8.0.0-preview.7.24251.11 | 20 | 06/05/2025 |
| 8.0.0-preview.6.24214.1 | 22 | 06/05/2025 |
| 8.0.0-preview.5.24201.12 | 18 | 06/05/2025 |