Aspire.Microsoft.Azure.Cosmos
8.0.0-preview.5.24201.12
Prefix Reserved
See the version list below for details.
dotnet add package Aspire.Microsoft.Azure.Cosmos --version 8.0.0-preview.5.24201.12
NuGet\Install-Package Aspire.Microsoft.Azure.Cosmos -Version 8.0.0-preview.5.24201.12
<PackageReference Include="Aspire.Microsoft.Azure.Cosmos" Version="8.0.0-preview.5.24201.12" />
paket add Aspire.Microsoft.Azure.Cosmos --version 8.0.0-preview.5.24201.12
#r "nuget: Aspire.Microsoft.Azure.Cosmos, 8.0.0-preview.5.24201.12"
// Install Aspire.Microsoft.Azure.Cosmos as a Cake Addin #addin nuget:?package=Aspire.Microsoft.Azure.Cosmos&version=8.0.0-preview.5.24201.12&prerelease // Install Aspire.Microsoft.Azure.Cosmos as a Cake Tool #tool nuget:?package=Aspire.Microsoft.Azure.Cosmos&version=8.0.0-preview.5.24201.12&prerelease
Aspire.Microsoft.Azure.Cosmos library
Registers CosmosClient as a singleton in the DI container for connecting to Azure Cosmos DB. Enables corresponding logging and telemetry.
Getting started
Prerequisites
- Azure subscription - create one for free
- Azure Cosmos DB account - create a Cosmos DB account
Install the package
Install the .NET Aspire Microsoft Azure Cosmos DB library with NuGet:
dotnet add package Aspire.Microsoft.Azure.Cosmos
Usage example
In the Program.cs file of your project, call the AddAzureCosmosDbClient
extension method to register a CosmosClient
for use via the dependency injection container. The method takes a connection name parameter.
builder.AddAzureCosmosDbClient("cosmosConnectionName");
You can then retrieve the CosmosClient
instance using dependency injection. For example, to retrieve the client from a Web API controller:
private readonly CosmosClient _client;
public ProductsController(CosmosClient client)
{
_client = client;
}
See the Azure Cosmos DB documentation for examples on using the CosmosClient
.
Configuration
The .NET Aspire Azure Cosmos DB library provides multiple options to configure the Azure Cosmos DB connection based on the requirements and conventions of your project. Note that either an AccountEndpoint
or a ConnectionString
is a required to be supplied.
Use a connection string
When using a connection string from the ConnectionStrings
configuration section, you can provide the name of the connection string when calling builder.AddAzureCosmosDbClient()
:
builder.AddAzureCosmosDbClient("cosmosConnectionName");
And then the connection string will be retrieved from the ConnectionStrings
configuration section. Two connection formats are supported:
Account Endpoint
The recommended approach is to use an AccountEndpoint, which works with the AzureCosmosDBSettings.Credential
property to establish a connection. If no credential is configured, the DefaultAzureCredential is used.
{
"ConnectionStrings": {
"cosmosConnectionName": "https://{account_name}.documents.azure.com:443/"
}
}
Connection string
Alternatively, an Azure Cosmos DB connection string can be used.
{
"ConnectionStrings": {
"cosmosConnectionName": "AccountEndpoint=https://{account_name}.documents.azure.com:443/;AccountKey={account_key};"
}
}
Use configuration providers
The .NET Aspire Microsoft Azure Cosmos DB library supports Microsoft.Extensions.Configuration. It loads the AzureCosmosDBSettings
and QueueClientOptions
from configuration by using the Aspire:Microsoft:Azure:Cosmos
key. Example appsettings.json
that configures some of the options:
{
"Aspire": {
"Microsoft": {
"Azure": {
"Cosmos": {
"Tracing": true,
}
}
}
}
}
Use inline delegates
You can also pass the Action<AzureCosmosDBSettings> configureSettings
delegate to set up some or all the options inline, for example to disable tracing from code:
builder.AddAzureCosmosDbClient("cosmosConnectionName", settings => settings.Tracing = false);
You can also setup the CosmosClientOptions using the optional Action<CosmosClientOptions> configureClientOptions
parameter of the AddAzureCosmosDbClient
method. For example, to set the ApplicationName
"User-Agent" header suffix for all requests issues by this client:
builder.AddAzureCosmosDbClient("cosmosConnectionName", configureClientOptions: clientOptions => clientOptions.ApplicationName = "myapp");
AppHost extensions
In your AppHost project, install the Aspire Azure CosmosDB Hosting library with NuGet:
dotnet add package Aspire.Hosting.Azure.CosmosDB
Then, in the Program.cs file of AppHost
, add a Cosmos DB connection and consume the connection using the following methods:
var cosmosdb = builder.AddAzureCosmosDB("cdb").AddDatabase("cosmosdb");
var myService = builder.AddProject<Projects.MyService>()
.WithReference(cosmosdb);
The AddAzureCosmosDB
method will read connection information from the AppHost's configuration (for example, from "user secrets") under the ConnectionStrings:cosmosdb
config key. 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:
builder.AddAzureCosmosDBClient("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.AddAzureCosmosDbClient("cosmos");
Additional documentation
- https://learn.microsoft.com/azure/cosmos-db/nosql/sdk-dotnet-v3
- https://github.com/dotnet/aspire/tree/main/src/Components/README.md
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. |
-
net8.0
- Azure.Identity (>= 1.10.4)
- Microsoft.Azure.Cosmos (>= 3.38.1)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.1)
- Microsoft.Extensions.Hosting.Abstractions (>= 8.0.0)
- OpenTelemetry.Extensions.Hosting (>= 1.7.0)
NuGet packages (2)
Showing the top 2 NuGet packages that depend on Aspire.Microsoft.Azure.Cosmos:
Package | Downloads |
---|---|
Hexalith.Infrastructure.AspireService.Hosting
Hexalith is a set of libraries to build a micro-service architecture. |
|
Sekiban.Aspire.Infrastructure.Cosmos
Sekiban - Event Sourcing Framework Cosmos Aspire Connector |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
8.1.0 | 1,992 | 7/23/2024 |
8.0.2 | 2,867 | 6/28/2024 |
8.0.1 | 6,476 | 5/21/2024 |
8.0.0 | 127 | 5/21/2024 |
8.0.0-preview.7.24251.11 | 900 | 5/7/2024 |
8.0.0-preview.6.24214.1 | 689 | 4/23/2024 |
8.0.0-preview.5.24201.12 | 689 | 4/9/2024 |
8.0.0-preview.4.24156.9 | 867 | 3/12/2024 |
8.0.0-preview.3.24105.21 | 2,150 | 2/13/2024 |
8.0.0-preview.2.23619.3 | 1,269 | 12/20/2023 |
8.0.0-preview.1.23557.2 | 852 | 11/14/2023 |