HealthStatus Enum

Definition

Namespace:

Microsoft.Extensions.Diagnostics.HealthChecks

Assembly:

Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions.dll

Package:

Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions v10.0.0-preview.1.25120.3

Represents the reported status of a health check result.

C#

public enum HealthStatus

Inheritance

Object

ValueType

Enum

HealthStatus

Fields

Name	Value	Description
Unhealthy	0	Indicates that the health check determined that the component was unhealthy, or an unhandled exception was thrown while executing the health check.
Degraded	1	Indicates that the health check determined that the component was in a degraded state.
Healthy	2	Indicates that the health check determined that the component was healthy.

Remarks

A status of Unhealthy should be considered the default value for a failing health check. Application developers may configure a health check to report a different status as desired.

The values of this enum or ordered from least healthy to most healthy. So Degraded is greater than Unhealthy but less than Healthy.

Applies to