Aspire.Hosting.Azure.CosmosDB 13.0.2

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Aspire.Hosting.Azure.CosmosDB --version 13.0.2
                    


                    

                
NuGet\Install-Package Aspire.Hosting.Azure.CosmosDB -Version 13.0.2
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.Azure.CosmosDB" Version="13.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Aspire.Hosting.Azure.CosmosDB" Version="13.0.2" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Aspire.Hosting.Azure.CosmosDB" />
                    


                            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.Azure.CosmosDB --version 13.0.2
                    


                    

                
#r "nuget: Aspire.Hosting.Azure.CosmosDB, 13.0.2"
#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.Azure.CosmosDB@13.0.2
#: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.Azure.CosmosDB&version=13.0.2
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Aspire.Hosting.Azure.CosmosDB&version=13.0.2
                    


                            Install as a Cake Tool

Aspire.Hosting.Azure.Cosmos library

Provides extension methods and resource definitions for an Aspire AppHost to configure Azure CosmosDB.

Getting started

Prerequisites

Install the package

In your AppHost project, install the Aspire Azure Cosmos DB Hosting library with NuGet:

dotnet add package Aspire.Hosting.Azure.CosmosDB

Configure Azure Provisioning for local development

Adding Azure resources to the Aspire application model will automatically enable development-time provisioning for Azure resources so that you don't need to configure them manually. Provisioning requires a number of settings to be available via .NET configuration. Set these values in user secrets in order to allow resources to be configured automatically.

{
    "Azure": {
      "SubscriptionId": "<your subscription id>",
      "ResourceGroupPrefix": "<prefix for the resource group>",
      "Location": "<azure location>"
    }
}

NOTE: Developers must have Owner access to the target subscription so that role assignments can be configured for the provisioned resources.

Usage example

Then, in the AppHost.cs file of AppHost, add a Cosmos DB connection and consume the connection using the following methods:

var cosmosdb = builder.AddAzureCosmosDB("cdb").AddCosmosDatabase("cosmosdb");

var myService = builder.AddProject<Projects.MyService>()
                       .WithReference(cosmosdb);

The WithReference method passes that connection information into a connection string named cosmosdb in the MyService project. In the Program.cs file of MyService, the connection can be consumed using the client library Aspire.Microsoft.Azure.Cosmos:

builder.AddAzureCosmosClient("cosmosdb");

Emulator usage

Aspire supports the usage of the Azure Cosmos DB emulator to use the emulator, add the following to your AppHost project:

// AppHost
var cosmosdb = builder.AddAzureCosmosDB("cosmos").RunAsEmulator();

When the AppHost starts up a local container running the Azure CosmosDB will also be started:

// Service code
builder.AddAzureCosmosClient("cosmos");

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.Azure.CosmosDB:

Package Downloads
Hexalith.Infrastructure.AspireService.Hosting

Hexalith is a set of libraries to build a micro-service architecture.
Hexalith.NetAspire.Hosting

Hexalith is a set of libraries to build an application with micro-service architecture.

GitHub repositories (3)

Showing the top 3 popular GitHub repositories that depend on Aspire.Hosting.Azure.CosmosDB:

Repository Stars
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.
IEvangelist/azure-cosmos-dotnet-repository
Wraps the .NET SDK for Azure Cosmos DB abstracting away the complexity, exposing a simple CRUD-based repository pattern
AzureCosmosDB/cosmosdb-nosql-copilot
Build a copilot application with Azure OpenAI Service, Azure Cosmos DB & Azure App Service.
Version Downloads Last Updated
13.0.2 93 12/4/2025
13.0.1 3,094 11/26/2025
13.0.0 10,778 11/11/2025
9.5.2 28,813 10/23/2025
9.5.1 18,642 10/3/2025
9.5.0 11,979 9/25/2025
9.4.2 31,882 9/2/2025
9.4.1 31,582 8/12/2025
9.4.0 17,477 7/29/2025
9.3.1 32,621 6/10/2025
9.3.0 34,074 5/19/2025
9.2.1 14,945 4/24/2025 9.2.1 is deprecated because it is no longer maintained.
9.2.0 10,800 4/10/2025 9.2.0 is deprecated because it is no longer maintained.
9.1.0 27,985 2/25/2025 9.1.0 is deprecated because it is no longer maintained.
9.0.0 57,336 11/12/2024 9.0.0 is deprecated because it is no longer maintained.
9.0.0-rc.1.24511.1 2,410 10/15/2024 9.0.0-rc.1.24511.1 is deprecated because it is no longer maintained.
8.2.2 6,419 10/24/2024 8.2.2 is deprecated because it is no longer maintained.
8.2.1 6,763 9/26/2024 8.2.1 is deprecated because it is no longer maintained.
8.2.0 17,373 8/29/2024 8.2.0 is deprecated because it is no longer maintained.
8.1.0 6,158 7/23/2024 8.1.0 is deprecated because it is no longer maintained.
8.0.2 2,780 6/28/2024 8.0.2 is deprecated because it is no longer maintained.
8.0.1 9,094 5/21/2024 8.0.1 is deprecated because it is no longer maintained.
8.0.0 790 5/21/2024 8.0.0 is deprecated because it is no longer maintained.
8.0.0-preview.7.24251.11 924 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 3,015 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 486 4/9/2024 8.0.0-preview.5.24201.12 is deprecated because it is no longer maintained.