Edit

.NET Aspire Azure Cosmos DB component

  • Article

In this article, you learn how to use the .NET Aspire Azure Cosmos DB component. The Aspire.Microsoft.Azure.Cosmos library is used to register a CosmosClient as a singleton in the DI container for connecting to Azure Cosmos DB. It also enables corresponding health checks, logging and telemetry.

Get started

To get started with the .NET Aspire Azure Cosmos DB component, install the Aspire.Microsoft.Azure.Cosmos NuGet package.

dotnet add package Aspire.Microsoft.Azure.Cosmos --prerelease

For more information, see dotnet add package or Manage package dependencies in .NET applications.

Example usage

In the Program.cs file of your component-consuming project, call the AddAzureCosmosDBClient extension to register a Microsoft.Azure.Cosmos.CosmosClient for use via the dependency injection container.

builder.AddAzureCosmosDBClient("cosmosConnectionName");

You can then retrieve the CosmosClient instance using dependency injection. For example, to retrieve the client from a service:

public class ExampleService(CosmosClient client)
{
    // Use client...
}

For more information on using the CosmosClient, see the Examples for Azure Cosmos DB for NoSQL SDK for .NET.

App host usage

To add Azure Cosmos DB hosting support to your IDistributedApplicationBuilder, install the Aspire.Hosting.Azure.CosmosDB NuGet package.

dotnet add package Aspire.Hosting.Azure.CosmosDB --prerelease

In your app host project, register the .NET Aspire Azure Cosmos DB component and consume the service using the following methods:

// Service registration
var cosmosdb = builder.ExecutionContext.IsPublishMode
    ? builder.AddAzureCosmosDB("cdb")
    : builder.AddConnectionString("cdb");

// Service consumption
var exampleProject = builder.AddProject<Projects.ExampleProject>()
                            .WithReference(cosmosdb);

The AddAzureCosmosDB method will read connection information from the AppHost's configuration under the ConnectionStrings:cosmosdb config key. The WithReference method passes that connection information into a connection string named cosmosdb in the ExampleProject project. In the Program.cs file of MyService, the connection can be consumed using:

builder.AddAzureCosmosDB("cosmosdb");

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.

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.AddAzureCosmosDB:

builder.AddAzureCosmosDB("cosmosConnectionName");

And then the connection string will be retrieved from the ConnectionStrings configuration section:

{
  "ConnectionStrings": {
    "cosmosConnectionName": "https://{account_name}.documents.azure.com:443/"
  }
}

The recommended connection approach is to use an account endpoint, 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/"
    }
}

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 Azure Cosmos DB component supports Microsoft.Extensions.Configuration. It loads the AzureCosmosDBSettings from appsettings.json or other configuration files using 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> delegate to set up some or all the options inline, for example to disable tracing from code:

builder.AddAzureCosmosDB(
    "cosmosConnectionName",
    static settings => settings.Tracing = false);

You can also set up the Microsoft.Azure.Cosmos.CosmosClientOptions using the optional Action<CosmosClientOptions> configureClientOptions parameter of the AddAzureCosmosDB method. For example to set the CosmosClientOptions.ApplicationName user-agent header suffix for all requests issues by this client:

builder.AddAzureCosmosDB(
    "cosmosConnectionName",
    configureClientOptions:
        clientOptions => clientOptions.ApplicationName = "myapp");

Health checks

By default, .NET Aspire components enable health checks for all services. For more information, see .NET Aspire components overview.

The .NET Aspire Azure Cosmos DB component currently doesn't implement health checks, though this may change in future releases.

Observability and telemetry

.NET Aspire components automatically set up Logging, Tracing, and Metrics configurations, which are sometimes known as the pillars of observability. For more information about component observability and telemetry, see .NET Aspire components overview. Depending on the backing service, some components may only support some of these features. For example, some components support logging and tracing, but not metrics. Telemetry features can also be disabled using the techniques presented in the Configuration section.

Logging

The .NET Aspire Azure Cosmos DB component uses the following log categories:

  • Azure-Cosmos-Operation-Request-Diagnostics

Tracing

The .NET Aspire Azure Cosmos DB component will emit the following tracing activities using OpenTelemetry:

  • Azure.Cosmos.Operation

Metrics

The .NET Aspire Azure Cosmos DB component currently doesn't support metrics by default due to limitations with the Azure SDK.

See also