Aspire.Hosting.MongoDB
13.3.3
Prefix Reserved
dotnet add package Aspire.Hosting.MongoDB --version 13.3.3
NuGet\Install-Package Aspire.Hosting.MongoDB -Version 13.3.3
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Aspire.Hosting.MongoDB" Version="13.3.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Aspire.Hosting.MongoDB" Version="13.3.3" />
<PackageReference Include="Aspire.Hosting.MongoDB" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Aspire.Hosting.MongoDB --version 13.3.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Aspire.Hosting.MongoDB, 13.3.3"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Aspire.Hosting.MongoDB@13.3.3
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Aspire.Hosting.MongoDB&version=13.3.3
#tool nuget:?package=Aspire.Hosting.MongoDB&version=13.3.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
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. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0
- Aspire.Hosting (>= 13.3.3)
- AspNetCore.HealthChecks.MongoDb (>= 9.0.0)
- AspNetCore.HealthChecks.Uris (>= 9.0.0)
- DnsClient (>= 1.8.0)
- Google.Protobuf (>= 3.33.5)
- Grpc.AspNetCore (>= 2.76.0)
- Grpc.Net.ClientFactory (>= 2.76.0)
- Grpc.Tools (>= 2.78.0)
- Humanizer.Core (>= 2.14.1)
- JsonPatch.Net (>= 3.3.0)
- KubernetesClient (>= 18.0.13)
- Microsoft.Extensions.Configuration.Abstractions (>= 10.0.7)
- Microsoft.Extensions.Configuration.Binder (>= 10.0.7)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.7)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.26)
- Microsoft.Extensions.FileSystemGlobbing (>= 10.0.7)
- Microsoft.Extensions.Hosting (>= 10.0.7)
- Microsoft.Extensions.Hosting.Abstractions (>= 10.0.7)
- Microsoft.Extensions.Http (>= 10.0.7)
- Microsoft.Extensions.Logging (>= 10.0.7)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.7)
- Microsoft.Extensions.Options (>= 10.0.7)
- Microsoft.Extensions.Primitives (>= 10.0.7)
- ModelContextProtocol (>= 1.0.0)
- MongoDB.Driver (>= 3.6.0)
- Newtonsoft.Json (>= 13.0.4)
- Polly.Core (>= 8.6.5)
- Semver (>= 3.0.0)
- StreamJsonRpc (>= 2.22.23)
- System.IO.Hashing (>= 10.0.3)
- System.Text.Json (>= 10.0.7)
NuGet packages (8)
Showing the top 5 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 |
|
|
Mango.Aspire.Hosting
Aspire integration for Mango — a friendly MongoDB workbench. Adds the Mango UI to a MongoDB resource via WithMango(). |
|
|
Sorvia.Aspire.Hosting.Dokploy
Aspire hosting integration for Dokploy — a self-hosted PaaS. Provides AddDokployEnvironment() to deploy Aspire resources to a Dokploy instance via Docker Compose generation and the Dokploy REST API. |
GitHub repositories (10)
Showing the top 10 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
|
|
|
zhuyongzhengs/Rex.ShopMicroService.Sample
一个基于ABP Framework 10.0、PostgreSQL、MongoDB、Redis、RabbitMQ、CAP、ElasticSearch、Minio、YARP的微服务电商商城平台，采用主流的互联网技术架构、全新的UI设计、可视化布局、支持集群部署；拥有活动促销、优惠卷、商品秒杀等众多完整的营销功能。
|
|
|
anuviswan/LearningPoint
A repository for learning different technologies, frameworks, features......
|
|
|
koralium/flowtide
High-performance streaming SQL query engine designed for real-time data processing. Use cases include event-driven architectures, ETL pipelines, and modern data-intensive applications.
|
|
|
PacktPublishing/Pragmatic-Microservices-with-CSharp-and-Azure
Pragmatic Microservices with C# and Azure, published by Packt
|
| Version | Downloads | Last Updated | |
|---|---|---|---|
| 13.3.3 | 1,333 | 5/15/2026 | |
| 13.3.2 | 1,087 | 5/14/2026 | |
| 13.3.1 | 1,514 | 5/12/2026 | |
| 13.3.0 | 5,192 | 5/7/2026 | |
| 13.2.4 | 12,747 | 4/24/2026 | |
| 13.2.3 | 4,019 | 4/21/2026 | |
| 13.2.2 | 18,550 | 4/8/2026 | |
| 13.2.1 | 7,996 | 3/31/2026 | |
| 13.2.0 | 15,629 | 3/23/2026 | |
| 13.1.3 | 4,897 | 3/19/2026 | |
| 13.1.2 | 28,073 | 2/26/2026 | |
| 13.1.1 | 34,547 | 2/11/2026 | |
| 13.1.0 | 71,587 | 12/17/2025 | |
| 13.0.2 | 17,156 | 12/4/2025 | |
| 13.0.1 | 6,379 | 11/26/2025 | |
| 13.0.0 | 22,179 | 11/11/2025 | |
| 9.5.2 | 39,060 | 10/23/2025 | |
| 9.5.1 | 25,238 | 10/3/2025 | |
| 9.5.0 | 8,682 | 9/25/2025 | |
| 9.4.2 | 20,768 | 9/2/2025 |
Loading failed