HealthCheckResult.Unhealthy(String, Exception, IReadOnlyDictionary<String,Object>) Method

Definition

Creates a HealthCheckResult representing an unhealthy component.

public static Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult Unhealthy (string description = null, Exception exception = null, System.Collections.Generic.IReadOnlyDictionary<string,object> data = null);
static member Unhealthy : string * Exception * System.Collections.Generic.IReadOnlyDictionary<string, obj> -> Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult

Parameters

description
String

A human-readable description of the status of the component that was checked. Optional.

exception
Exception

An Exception representing the exception that was thrown when checking for status. Optional.

data
IReadOnlyDictionary<String,Object>

Additional key-value pairs describing the health of the component. Optional.

Returns

A HealthCheckResult representing an unhealthy component.

Applies to