HealthCheckResult Struct

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 result of a health check.

C#

public struct HealthCheckResult

Inheritance

Object

ValueType

HealthCheckResult

Constructors

HealthCheckResult(HealthStatus, String, Exception, IReadOnlyDictionary<String,Object>)

Creates a new HealthCheckResult with the specified values for status, exception, description, and data.

Properties

Data	Gets additional key-value pairs describing the health of the component.
Description	Gets a human-readable description of the status of the component that was checked.
Exception	Gets an Exception representing the exception that was thrown when checking for status (if any).
Status	Gets a value indicating the status of the component that was checked.

Methods

Degraded(String, Exception, IReadOnlyDictionary<String,Object>)	Creates a HealthCheckResult representing a degraded component.
Healthy(String, IReadOnlyDictionary<String,Object>)	Creates a HealthCheckResult representing a healthy component.
Unhealthy(String, Exception, IReadOnlyDictionary<String,Object>)	Creates a HealthCheckResult representing an unhealthy component.

Applies to