Aspire.Hosting.Azure.CosmosDB 13.5.0

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


                    

                
NuGet\Install-Package Aspire.Hosting.Azure.CosmosDB -Version 13.5.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.Azure.CosmosDB" Version="13.5.0" />
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.5.0" />
                    


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


                    

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


                            Install as a Cake Addin
                        

                    

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


                            Install as a Cake Tool

Azure Cosmos DB hosting integration

Use this integration to model, configure, and orchestrate Azure CosmosDB in an Aspire solution.

Getting started

Prerequisites

Add the integration

From your AppHost directory, add the Aspire.Hosting.Azure.CosmosDB integration with the Aspire CLI:

aspire add Aspire.Hosting.Azure.CosmosDB

Configure Azure Provisioning for local development

Adding Azure resources to the AppHost 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 AppHost configuration. From your AppHost directory, set these values with aspire secret set:

aspire secret set Azure:SubscriptionId "<your subscription id>"
aspire secret set Azure:ResourceGroupPrefix "<prefix for the resource group>"
aspire secret set Azure: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

In the AppHost, add a Cosmos DB connection and reference it from another resource with either C# or TypeScript:

C#

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

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

TypeScript

const cosmosdb = await builder.addAzureCosmosDB("cdb").addCosmosDatabase("cosmosdb");

const myService = await builder.addNodeApp("myService", "../my-service", "server.js")
                       .withReference(cosmosdb);

Connection Properties

When you reference Azure Cosmos DB resources using WithReference, the following connection properties are made available to the consuming project:

Cosmos DB account

The Cosmos DB account resource exposes the following connection properties:

Property Name Description
Uri The account endpoint URI for the Cosmos DB account, with the format https://mycosmosaccount.documents.azure.com:443/
AccountKey The account key for the Cosmos DB account (only available for emulator and access key authentication)
ConnectionString Emulator or access key authentication only. A full connection string (includes account key for emulator; access key secret when access key auth is enabled).

Cosmos DB database

The Cosmos DB database resource inherits all properties from its parent Cosmos DB account and adds:

Property Name Description
DatabaseName The name of the database

Cosmos DB container

The Cosmos DB container resource inherits all properties from its parent Cosmos DB database and adds:

Property Name Description
ContainerName The name of the container

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/microsoft/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 (4)

Showing the top 4 NuGet packages that depend on Aspire.Hosting.Azure.CosmosDB:

Package Downloads
Aspire.Hosting.Foundry

Microsoft Foundry resource types for Aspire.
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.
MMCA.Common.Aspire.Hosting

MMCA framework: Aspire AppHost extension methods for the cross-cutting infrastructure (RabbitMQ broker, JWKS service discovery, gRPC project wiring) used by extracted microservice deployments

GitHub repositories (4)

Showing the top 4 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 10, Wolverine, 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.
PacktPublishing/Pragmatic-Microservices-with-CSharp-and-Azure
Pragmatic Microservices with C# and Azure, published by Packt
Version Downloads Last Updated
13.5.0 0 8/18/2026
13.4.6 133,308 6/19/2026
13.4.5 12,940 6/17/2026
13.4.4 8,075 6/15/2026
13.4.3 24,440 6/8/2026
13.4.2 80,616 6/3/2026
13.4.1 1,036 6/3/2026
13.4.0 36,273 6/1/2026
13.3.5 55,097 5/21/2026
13.3.4 11,880 5/19/2026
13.3.3 14,161 5/15/2026
13.3.2 6,264 5/14/2026
13.3.1 7,940 5/12/2026
13.3.0 15,268 5/7/2026
13.2.4 44,522 4/24/2026
13.2.3 16,756 4/21/2026
13.2.2 62,394 4/8/2026
13.2.1 19,892 3/31/2026
13.2.0 29,889 3/23/2026
13.1.3 10,899 3/19/2026
Loading failed