IHealthChecksBuilder Interface

Definition

Namespace:: Microsoft.Extensions.DependencyInjection

Assembly:: Microsoft.Extensions.Diagnostics.HealthChecks.dll

Package:: Microsoft.Extensions.Diagnostics.HealthChecks v11.0.0-rc.1.26425.128

Source:: IHealthChecksBuilder.cs

Source:: IHealthChecksBuilder.cs

Source:: IHealthChecksBuilder.cs

Source:: IHealthChecksBuilder.cs

Source:: IHealthChecksBuilder.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A builder used to register health checks.

public interface class IHealthChecksBuilder

public interface IHealthChecksBuilder

type IHealthChecksBuilder = interface

Public Interface IHealthChecksBuilder

Properties

Name	Description
Services	Gets the IServiceCollection into which IHealthCheck instances should be registered.

Methods

Name	Description
Add(HealthCheckRegistration)	Adds a HealthCheckRegistration for a health check.

Extension Methods

Name	Description
AddApplicationLifecycleHealthCheck(IHealthChecksBuilder, IEnumerable)	Registers a health check provider that's tied to the application's lifecycle.
AddApplicationLifecycleHealthCheck(IHealthChecksBuilder, String[])	Registers a health check provider that's tied to the application's lifecycle.
AddAsyncCheck(IHealthChecksBuilder, String, Func>, IEnumerable, Nullable)	Adds a new health check with the specified name and implementation.
AddAsyncCheck(IHealthChecksBuilder, String, Func>, IEnumerable)	Adds a new health check with the specified name and implementation.
AddAsyncCheck(IHealthChecksBuilder, String, Func>, IEnumerable, Nullable)	Adds a new health check with the specified name and implementation.
AddAsyncCheck(IHealthChecksBuilder, String, Func>, IEnumerable)	Adds a new health check with the specified name and implementation.
AddCheck(IHealthChecksBuilder, String, Func, IEnumerable, Nullable)	Adds a new health check with the specified name and implementation.
AddCheck(IHealthChecksBuilder, String, Func, IEnumerable)	Adds a new health check with the specified name and implementation.
AddCheck(IHealthChecksBuilder, String, Func, IEnumerable, Nullable)	Adds a new health check with the specified name and implementation.
AddCheck(IHealthChecksBuilder, String, Func, IEnumerable)	Adds a new health check with the specified name and implementation.
AddCheck(IHealthChecksBuilder, String, IHealthCheck, Nullable, IEnumerable, Nullable)	Adds a new health check with the specified name and implementation.
AddCheck(IHealthChecksBuilder, String, IHealthCheck, Nullable, IEnumerable)	Adds a new health check with the specified name and implementation.
AddCheck(IHealthChecksBuilder, String, Nullable, IEnumerable, Nullable)	Adds a new health check with the specified name and implementation.
AddCheck(IHealthChecksBuilder, String, Nullable, IEnumerable)	Adds a new health check with the specified name and implementation.
AddDbContextCheck(IHealthChecksBuilder, String, Nullable, IEnumerable, Func>)	Adds a health check for the specified DbContext type.
AddManualHealthCheck(IHealthChecksBuilder, IEnumerable)	Registers a health check provider that enables manual control of the application's health.
AddManualHealthCheck(IHealthChecksBuilder, String[])	Registers a health check provider that enables manual control of the application's health.
AddResourceUtilizationHealthCheck(IHealthChecksBuilder, Action, IEnumerable)	Registers a health check provider that monitors resource utilization to assess the application's health.
AddResourceUtilizationHealthCheck(IHealthChecksBuilder, Action, String[])	Registers a health check provider that monitors resource utilization to assess the application's health.
AddResourceUtilizationHealthCheck(IHealthChecksBuilder, Action)	Registers a health check provider that monitors resource utilization to assess the application's health.
AddResourceUtilizationHealthCheck(IHealthChecksBuilder, IConfigurationSection, IEnumerable)	Registers a health check provider that monitors resource utilization to assess the application's health.
AddResourceUtilizationHealthCheck(IHealthChecksBuilder, IConfigurationSection, String[])	Registers a health check provider that monitors resource utilization to assess the application's health.
AddResourceUtilizationHealthCheck(IHealthChecksBuilder, IConfigurationSection)	Registers a health check provider that monitors resource utilization to assess the application's health.
AddResourceUtilizationHealthCheck(IHealthChecksBuilder, IEnumerable)	Registers a health check provider that monitors resource utilization to assess the application's health.
AddResourceUtilizationHealthCheck(IHealthChecksBuilder, String[])	Registers a health check provider that monitors resource utilization to assess the application's health.
AddTypeActivatedCheck(IHealthChecksBuilder, String, Nullable, IEnumerable, Object[])	Adds a new type activated health check with the specified name and implementation.
AddTypeActivatedCheck(IHealthChecksBuilder, String, Nullable, IEnumerable, TimeSpan, Object[])	Adds a new type activated health check with the specified name and implementation.
AddTypeActivatedCheck(IHealthChecksBuilder, String, Nullable, Object[])	Adds a new type activated health check with the specified name and implementation.
AddTypeActivatedCheck(IHealthChecksBuilder, String, Object[])	Adds a new type activated health check with the specified name and implementation.

Applies to

Feedback

Was this page helpful?