AspNetCore.HealthChecks.CosmosDb 9.0.0

dotnet add package AspNetCore.HealthChecks.CosmosDb --version 9.0.0                
NuGet\Install-Package AspNetCore.HealthChecks.CosmosDb -Version 9.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="AspNetCore.HealthChecks.CosmosDb" Version="9.0.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add AspNetCore.HealthChecks.CosmosDb --version 9.0.0                
#r "nuget: AspNetCore.HealthChecks.CosmosDb, 9.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.
// Install AspNetCore.HealthChecks.CosmosDb as a Cake Addin
#addin nuget:?package=AspNetCore.HealthChecks.CosmosDb&version=9.0.0

// Install AspNetCore.HealthChecks.CosmosDb as a Cake Tool
#tool nuget:?package=AspNetCore.HealthChecks.CosmosDb&version=9.0.0                

Azure Cosmos DB Health Check

This health check verifies the ability to communicate with Azure Cosmos DB. It uses the provided CosmosClient.

Defaults

By default, the CosmosClient instance is resolved from service provider. AzureCosmosDbHealthCheckOptions does not provide any specific containers or database ids, the health check just calls CosmosClient.ReadAccountAsync.

void Configure(IHealthChecksBuilder builder)
{
    builder.Services.AddSingleton(sp => new CosmosClient(
        "endpoint-from-portal",
        new DefaultAzureCredential()));
    builder.AddHealthChecks().AddAzureCosmosDB();
}

Customization

You can additionally add the following parameters:

  • clientFactory: A factory method to provide CosmosClient instance.
  • optionsFactory: A factory method to provide AzureCosmosDbHealthCheckOptions instance. It allows to specify the database id and/or container id(s).
  • name: The health check name. The default is azure_cosmosdb.
  • failureStatus: The HealthStatus that should be reported when the health check fails. Default is HealthStatus.Unhealthy.
  • tags: A list of tags that can be used to filter sets of health checks.
  • timeout: A System.TimeSpan representing the timeout of the check.
void Configure(IHealthChecksBuilder builder)
{
    builder.Services.AddSingleton(sp => new CosmosClient(
        "endpoint-from-portal",
        new DefaultAzureCredential(),
        new CosmosClientOptions()
        {
            ApplicationRegion = Regions.EastUS2,
        }));
    builder.AddHealthChecks().AddAzureCosmosDB(
        optionsFactory: sp => new AzureCosmosDbHealthCheckOptions()
        {
            DatabaseId = "demo"
        });
}

Breaking changes

In the prior releases, CosmosDbHealthCheck was a part of HealthChecks.CosmosDb package. It had a dependency on not just Microsoft.Azure.Cosmos, but also Azure.Data.Tables. The packages have been split to avoid bringing unnecessary dependencies. Moreover, CosmosDbHealthCheck was letting the users specify how CosmosClient should be created (from raw connection string or from endpoint and managed identity credentials), at a cost of maintaining an internal, static client instances cache. Now the type does not create client instances nor maintain an internal cache and it's the caller responsibility to provide the instance of CosmosClient (please see #2040 for more details). Since Azure SDK recommends treating clients as singletons <see href="https://devblogs.microsoft.com/azure-sdk/lifetime-management-and-thread-safety-guarantees-of-azure-sdk-net-clients/"/> and client instances can be expensive to create, it's recommended to register a singleton factory method for Azure SDK clients. So the clients are created only when needed and once per whole application lifetime.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (7)

Showing the top 5 NuGet packages that depend on AspNetCore.HealthChecks.CosmosDb:

Package Downloads
IEvangelist.Azure.CosmosRepository.AspNetCore

This client library enables client applications to connect to Azure Cosmos via a repository pattern around the official Azure Cosmos .NET SDK. Azure Cosmos is a globally distributed, multi-model database service. For more information, refer to http://azure.microsoft.com/services/cosmos-db/.

Aspire.Hosting.Azure.CosmosDB

Azure Cosmos DB resource types for .NET Aspire.

EaCloud.AspNetCore.Diagnostics

EaCloud AspNetCore 性能诊断组件,提供 AspNetCore 性能诊断功能的封装。

IceArtefact.Infrastructure.HealthCheck

Package Description

BridgingIT.DevKit.Infrastructure.EntityFramework.Cosmos

BridgingIT DevKit: Empowering developers with modular components for modern application development, centered around Domain-Driven Design principles. Our goal is to empower developers by offering modular components that can be easily integrated into your projects. Whether you're working with repositories, commands, queries, or other components, the bITDevKit provides flexible solutions that can adapt to your specific needs.

GitHub repositories (2)

Showing the top 2 popular GitHub repositories that depend on AspNetCore.HealthChecks.CosmosDb:

Repository Stars
dotnet/aspire
Tools, templates, and packages to accelerate building observable, production-ready apps
IEvangelist/azure-cosmos-dotnet-repository
Wraps the .NET SDK for Azure Cosmos DB abstracting away the complexity, exposing a simple CRUD-based repository pattern
Version Downloads Last updated
9.0.0 630 12/19/2024
8.0.1 866,855 4/2/2024
8.0.0 278,173 12/15/2023
7.1.0 211,647 9/19/2023
7.0.0 153,015 7/30/2023
7.0.0-rc2.5 30,824 3/13/2023
7.0.0-rc2.4 15,719 1/14/2023
7.0.0-rc2.3 286 12/27/2022
7.0.0-rc2.2 1,255 12/27/2022
6.1.0 2,086,508 8/18/2022
6.0.3 140,439 7/30/2022
6.0.2 589,358 2/28/2022
6.0.1 196,214 12/29/2021
6.0.1-rc2.1 22,951 11/27/2021
6.0.0 27,912 12/29/2021
5.0.4 243,332 7/14/2021
5.0.3 136,781 3/9/2021
5.0.2 654 3/8/2021
5.0.1 28,703 1/5/2021
5.0.0 1,151 12/29/2020
5.0.0-preview1 421 11/22/2020
3.2.1-preview 11,141 9/14/2020
3.2.0-preview 419 9/3/2020
3.1.2 529,711 9/1/2020
3.1.1 151,081 4/17/2020
3.1.0 39,515 4/9/2020
3.0.0 60,712 9/24/2019
2.2.0 43,109 9/17/2019
2.2.0-preview 6,568 4/9/2019