HealthCheckResult.Unhealthy Method

Definition

Creates a HealthCheckResult representing an unhealthy component.

public static Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult Unhealthy (string? description = default, Exception? exception = default, System.Collections.Generic.IReadOnlyDictionary<string,object>? data = default);

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

Продукт Версии
.NET 8 (package-provided), 9 (package-provided)
.NET Framework 4.7 (package-provided), 4.7.1 (package-provided), 4.7.2 (package-provided), 4.8 (package-provided)
.NET Standard 2.0 (package-provided)