AspNetCore.HealthChecks.AzureKeyVault 8.0.0

There is a newer version of this package available.
See the version list below for details.

dotnet add package AspNetCore.HealthChecks.AzureKeyVault --version 8.0.0

NuGet\Install-Package AspNetCore.HealthChecks.AzureKeyVault -Version 8.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.AzureKeyVault" Version="8.0.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add AspNetCore.HealthChecks.AzureKeyVault --version 8.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: AspNetCore.HealthChecks.AzureKeyVault, 8.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.AzureKeyVault as a Cake Addin
#addin nuget:?package=AspNetCore.HealthChecks.AzureKeyVault&version=8.0.0

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

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Azure KeyVault Health Check

This health check verifies the ability to communicate with Azure Key Vault and the existence of some secrets, keys and certificates. For more information about Azure Key Vault check the Azure KeyVault Microsoft Site

Example Usage

With all of the following examples, you can additionally add the following parameters:

name: The health check name. Default if not specified is azurekeyvault.
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.

Basic

public void ConfigureServices(IServiceCollection services)
{
    services
        .AddHealthChecks()
        .AddAzureKeyVault(new Uri("azure-key-vault-uri"), new DefaultAzureCredential(), options =>
        {
            options
                .AddSecret("secretname")
                .AddKey("keyname")
                .AddCertificate("certificatename");
        });
}

For more information about credentials types please see Azure TokenCredentials

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 was computed. 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.

.NETStandard 2.0
- Azure.Security.KeyVault.Certificates (>= 4.5.1)
- Azure.Security.KeyVault.Keys (>= 4.5.0)
- Azure.Security.KeyVault.Secrets (>= 4.5.0)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.0)

NuGet packages (5)

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

Package	Downloads
Nuuvify.CommonPack.HealthCheck HealthChecks - Setup e configuracao do endpoint /hc-ui e /hc	21.8K
Igive.Common Package Description	19.3K
Rixian.Extensions.AspNetCore.DataProtection Data Protection extensions for Asp.Net Core.	14.9K
Inova.Template.API Package Description	202
Maxia.Commons.WebApi Package Description	83

GitHub repositories

This package is not used by any popular GitHub repositories.