Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

IHealthCheck Interface

Definition

Namespace:
Microsoft.Extensions.Diagnostics.HealthChecks
Assembly:
Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions.dll
Package:
Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions v11.0.0-preview.5.26302.115
Source:
IHealthCheck.cs
Source:
IHealthCheck.cs
Source:
IHealthCheck.cs
Source:
IHealthCheck.cs
Source:
IHealthCheck.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.

Represents a health check, which can be used to check the status of a component in the application, such as a backend service, database or some internal state.

public interface class IHealthCheck
public interface IHealthCheck
type IHealthCheck = interface
Public Interface IHealthCheck

Methods

Name Description
CheckHealthAsync(HealthCheckContext, CancellationToken)

Runs the health check, returning the status of the component being checked.

Applies to


Feedback

Was this page helpful?