Aspire.Hosting.MongoDB
13.1.2
Prefix Reserved
dotnet add package Aspire.Hosting.MongoDB --version 13.1.2
NuGet\Install-Package Aspire.Hosting.MongoDB -Version 13.1.2
<PackageReference Include="Aspire.Hosting.MongoDB" Version="13.1.2" />
<PackageVersion Include="Aspire.Hosting.MongoDB" Version="13.1.2" />
<PackageReference Include="Aspire.Hosting.MongoDB" />
paket add Aspire.Hosting.MongoDB --version 13.1.2
#r "nuget: Aspire.Hosting.MongoDB, 13.1.2"
#:package Aspire.Hosting.MongoDB@13.1.2
#addin nuget:?package=Aspire.Hosting.MongoDB&version=13.1.2
#tool nuget:?package=Aspire.Hosting.MongoDB&version=13.1.2
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 |
|---|---|
DatabaseName |
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
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net8.0
- Aspire.Hosting (>= 13.1.2)
- AspNetCore.HealthChecks.MongoDb (>= 9.0.0)
- AspNetCore.HealthChecks.Uris (>= 9.0.0)
- DnsClient (>= 1.8.0)
- Google.Protobuf (>= 3.33.0)
- Grpc.AspNetCore (>= 2.71.0)
- Grpc.Net.ClientFactory (>= 2.71.0)
- Grpc.Tools (>= 2.72.0)
- Humanizer.Core (>= 2.14.1)
- JsonPatch.Net (>= 3.3.0)
- KubernetesClient (>= 18.0.5)
- Microsoft.Extensions.Configuration.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.2)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.22)
- Microsoft.Extensions.FileSystemGlobbing (>= 10.0.1)
- Microsoft.Extensions.Hosting (>= 8.0.1)
- Microsoft.Extensions.Hosting.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Http (>= 8.0.1)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.3)
- Microsoft.Extensions.Options (>= 8.0.2)
- Microsoft.Extensions.Primitives (>= 8.0.0)
- MongoDB.Driver (>= 3.5.0)
- Newtonsoft.Json (>= 13.0.4)
- Polly.Core (>= 8.6.4)
- Semver (>= 3.0.0)
- StreamJsonRpc (>= 2.22.23)
- System.IO.Hashing (>= 9.0.10)
NuGet packages (4)
Showing the top 4 NuGet packages that depend on Aspire.Hosting.MongoDB:
| Package | Downloads |
|---|---|
|
CommunityToolkit.Aspire.Hosting.MongoDB.Extensions
An Aspire integration for extending mongodb hosting. |
|
|
ReplicaSet.Aspire.MongoDB
Add replica set to MongoDB when using Aspire |
|
|
NetCorePal.Aspire.Hosting.MongoDB
Add replica set to MongoDB when using Aspire |
|
|
DmitryNovik.ReplicaSet.Aspire.MongoDB
Add replica set to MongoDB when using Aspire |
GitHub repositories (8)
Showing the top 8 popular GitHub repositories that depend on Aspire.Hosting.MongoDB:
| Repository | Stars |
|---|---|
|
meysamhadeli/booking-microservices
A practical microservices with the latest technologies and architectures like Vertical Slice Architecture, Event Sourcing, CQRS, DDD, gRpc, MongoDB, RabbitMq, Masstransit, and Aspire in .Net 10.
|
|
|
grandnode/grandnode2
E-commerce platform built with ASP.NET Core using MongoDB for NoSQL storage
|
|
|
mehdihadeli/food-delivery-microservices
🍔 A practical and cloud-native food delivery microservices, built with .Net Aspire, .Net 9, MassTransit, Domain-Driven Design, CQRS, Vertical Slice Architecture, Event-Driven Architecture, and the latest technologies.
|
|
|
CommunityToolkit/Aspire
A community project with additional components and extensions for Aspire
|
|
|
meysamhadeli/booking-modular-monolith
A practical Modular Monolith architecture with the latest technologies and architecture like Vertical Slice Architecture, Event Driven Architecture, CQRS, DDD, gRpc, Masstransit, and Aspire in .Net 10.
|
|
|
daohainam/microservice-patterns
Microservice pattern demos (Saga, EventSourcing, CQRS...) running on .NET Aspire
|
|
|
formcms/formcms
AI Agent: Open-source headless CMS built with ASP.NET Core (C#) and React, featuring REST APIs, GraphQL, and a GrapesJS page designer.
|
|
|
anuviswan/LearningPoint
A repository for learning different technologies, frameworks, features......
|
| Version | Downloads | Last Updated | |
|---|---|---|---|
| 13.1.2 | 5,754 | 2/26/2026 | |
| 13.1.1 | 14,682 | 2/11/2026 | |
| 13.1.0 | 40,724 | 12/17/2025 | |
| 13.0.2 | 13,352 | 12/4/2025 | |
| 13.0.1 | 5,334 | 11/26/2025 | |
| 13.0.0 | 17,356 | 11/11/2025 | |
| 9.5.2 | 27,846 | 10/23/2025 | |
| 9.5.1 | 17,511 | 10/3/2025 | |
| 9.5.0 | 7,487 | 9/25/2025 | |
| 9.4.2 | 16,645 | 9/2/2025 | |
| 9.4.1 | 12,307 | 8/12/2025 | |
| 9.4.0 | 10,832 | 7/29/2025 | |
| 9.3.1 | 37,241 | 6/10/2025 | |
| 9.3.0 | 19,741 | 5/19/2025 | |
| 9.2.1 | 11,855 | 4/24/2025 | |
| 9.2.0 | 15,032 | 4/10/2025 | |
| 9.1.0 | 46,642 | 2/25/2025 | |
| 9.0.0 | 44,363 | 11/12/2024 | |
| 9.0.0-rc.1.24511.1 | 1,617 | 10/15/2024 | |
| 8.2.2 | 10,796 | 10/24/2024 |