IHealthChecksBuilder Interface

Definition

Namespace:

Microsoft.Extensions.DependencyInjection

Assembly:

Microsoft.Extensions.Diagnostics.HealthChecks.dll

Package:

Microsoft.Extensions.Diagnostics.HealthChecks v8.0.0

Source:

IHealthChecksBuilder.cs

A builder used to register health checks.

public interface class IHealthChecksBuilder

public interface IHealthChecksBuilder

type IHealthChecksBuilder = interface

Public Interface IHealthChecksBuilder

Properties

Services

Gets the IServiceCollection into which IHealthCheck instances should be registered.

Methods

Add(HealthCheckRegistration)

Adds a HealthCheckRegistration for a health check.

Extension Methods

AddApplicationLifecycleHealthCheck(IHealthChecksBuilder, IEnumerable<String>)	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.
AddManualHealthCheck(IHealthChecksBuilder, IEnumerable<String>)	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.
AddDbContextCheck<TContext>(IHealthChecksBuilder, String, Nullable<HealthStatus>, IEnumerable<String>, Func<TContext,CancellationToken,Task<Boolean>>)	Adds a health check for the specified DbContext type.
AddCheck(IHealthChecksBuilder, String, IHealthCheck, Nullable<HealthStatus>, IEnumerable<String>)	Adds a new health check with the specified name and implementation.
AddCheck(IHealthChecksBuilder, String, IHealthCheck, Nullable<HealthStatus>, IEnumerable<String>, Nullable<TimeSpan>)	Adds a new health check with the specified name and implementation.
AddCheck<T>(IHealthChecksBuilder, String, Nullable<HealthStatus>, IEnumerable<String>)	Adds a new health check with the specified name and implementation.
AddCheck<T>(IHealthChecksBuilder, String, Nullable<HealthStatus>, IEnumerable<String>, Nullable<TimeSpan>)	Adds a new health check with the specified name and implementation.
AddTypeActivatedCheck<T>(IHealthChecksBuilder, String, Nullable<HealthStatus>, IEnumerable<String>, Object[])	Adds a new type activated health check with the specified name and implementation.
AddTypeActivatedCheck<T>(IHealthChecksBuilder, String, Nullable<HealthStatus>, IEnumerable<String>, TimeSpan, Object[])	Adds a new type activated health check with the specified name and implementation.
AddTypeActivatedCheck<T>(IHealthChecksBuilder, String, Nullable<HealthStatus>, Object[])	Adds a new type activated health check with the specified name and implementation.
AddTypeActivatedCheck<T>(IHealthChecksBuilder, String, Object[])	Adds a new type activated health check with the specified name and implementation.
AddAsyncCheck(IHealthChecksBuilder, String, Func<CancellationToken,Task<HealthCheckResult>>, IEnumerable<String>)	Adds a new health check with the specified name and implementation.
AddAsyncCheck(IHealthChecksBuilder, String, Func<CancellationToken,Task<HealthCheckResult>>, IEnumerable<String>, Nullable<TimeSpan>)	Adds a new health check with the specified name and implementation.
AddAsyncCheck(IHealthChecksBuilder, String, Func<Task<HealthCheckResult>>, IEnumerable<String>)	Adds a new health check with the specified name and implementation.
AddAsyncCheck(IHealthChecksBuilder, String, Func<Task<HealthCheckResult>>, IEnumerable<String>, Nullable<TimeSpan>)	Adds a new health check with the specified name and implementation.
AddCheck(IHealthChecksBuilder, String, Func<HealthCheckResult>, IEnumerable<String>)	Adds a new health check with the specified name and implementation.
AddCheck(IHealthChecksBuilder, String, Func<HealthCheckResult>, IEnumerable<String>, Nullable<TimeSpan>)	Adds a new health check with the specified name and implementation.
AddCheck(IHealthChecksBuilder, String, Func<CancellationToken,HealthCheckResult>, IEnumerable<String>)	Adds a new health check with the specified name and implementation.
AddCheck(IHealthChecksBuilder, String, Func<CancellationToken,HealthCheckResult>, IEnumerable<String>, Nullable<TimeSpan>)	Adds a new health check with the specified name and implementation.
AddResourceUtilizationHealthCheck(IHealthChecksBuilder, IConfigurationSection)	Registers a health check provider that monitors resource utilization to assess the application's health.
AddResourceUtilizationHealthCheck(IHealthChecksBuilder, IConfigurationSection, IEnumerable<String>)	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, Action<ResourceUtilizationHealthCheckOptions>)	Registers a health check provider that monitors resource utilization to assess the application's health.
AddResourceUtilizationHealthCheck(IHealthChecksBuilder, Action<ResourceUtilizationHealthCheckOptions>, IEnumerable<String>)	Registers a health check provider that monitors resource utilization to assess the application's health.
AddResourceUtilizationHealthCheck(IHealthChecksBuilder, Action<ResourceUtilizationHealthCheckOptions>, String[])	Registers a health check provider that monitors resource utilization to assess the application's health.
AddResourceUtilizationHealthCheck(IHealthChecksBuilder, IEnumerable<String>)	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.