Aspire.Hosting.MongoDB 13.0.0

Prefix Reserved
dotnet add package Aspire.Hosting.MongoDB --version 13.0.0
                    
NuGet\Install-Package Aspire.Hosting.MongoDB -Version 13.0.0
                    
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.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Aspire.Hosting.MongoDB" Version="13.0.0" />
                    
Directory.Packages.props
<PackageReference Include="Aspire.Hosting.MongoDB" />
                    
Project file
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.0.0
                    
#r "nuget: Aspire.Hosting.MongoDB, 13.0.0"
                    
#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.0.0
                    
#: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.0.0
                    
Install as a Cake Addin
#tool nuget:?package=Aspire.Hosting.MongoDB&version=13.0.0
                    
Install as a Cake Tool

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

https://github.com/dotnet/aspire

Product 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.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on Aspire.Hosting.MongoDB:

Package Downloads
CommunityToolkit.Aspire.Hosting.MongoDB.Extensions

A .NET Aspire integration for extending mongodb hosting.

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
grandnode/grandnode2
E-commerce platform built with ASP.NET Core using MongoDB for NoSQL storage
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 9.
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 .NET 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 9.
daohainam/microservice-patterns
Microservice pattern demos (Saga, EventSourcing, CQRS...) running on .NET Aspire
formcms/formcms
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.0.0 470 11/11/2025
9.5.2 5,044 10/23/2025
9.5.1 10,968 10/3/2025
9.5.0 5,790 9/25/2025
9.4.2 9,869 9/2/2025
9.4.1 10,464 8/12/2025
9.4.0 8,200 7/29/2025
9.3.1 26,686 6/10/2025
9.3.0 16,522 5/19/2025
9.2.1 10,316 4/24/2025 9.2.1 is deprecated because it is no longer maintained.
9.2.0 11,625 4/10/2025 9.2.0 is deprecated because it is no longer maintained.
9.1.0 39,387 2/25/2025 9.1.0 is deprecated because it is no longer maintained.
9.0.0 40,545 11/12/2024 9.0.0 is deprecated because it is no longer maintained.
9.0.0-rc.1.24511.1 1,497 10/15/2024 9.0.0-rc.1.24511.1 is deprecated because it is no longer maintained.
8.2.2 8,283 10/24/2024 8.2.2 is deprecated because it is no longer maintained.
8.2.1 8,276 9/26/2024 8.2.1 is deprecated because it is no longer maintained.
8.2.0 7,749 8/29/2024 8.2.0 is deprecated because it is no longer maintained.
8.1.0 5,082 7/23/2024 8.1.0 is deprecated because it is no longer maintained.
8.0.2 1,781 6/28/2024 8.0.2 is deprecated because it is no longer maintained.
8.0.1 3,904 5/21/2024 8.0.1 is deprecated because it is no longer maintained.
8.0.0 868 5/21/2024 8.0.0 is deprecated because it is no longer maintained.
8.0.0-preview.7.24251.11 1,366 5/7/2024 8.0.0-preview.7.24251.11 is deprecated because it is no longer maintained.
8.0.0-preview.6.24214.1 1,200 4/23/2024 8.0.0-preview.6.24214.1 is deprecated because it is no longer maintained.
8.0.0-preview.5.24201.12 1,306 4/9/2024 8.0.0-preview.5.24201.12 is deprecated because it is no longer maintained.