HealthCheckResult.Unhealthy Method

Definition

Namespace:

Microsoft.Extensions.Diagnostics.HealthChecks

Assembly:

Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions.dll

Package:

Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions v8.0.10

Source:

HealthCheckResult.cs

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);

static member Unhealthy : string * Exception * System.Collections.Generic.IReadOnlyDictionary<string, obj> -> Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult

Public Shared Function Unhealthy (Optional description As String = Nothing, Optional exception As Exception = Nothing, Optional data As IReadOnlyDictionary(Of String, Object) = Nothing) As 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

HealthCheckResult

A HealthCheckResult representing an unhealthy component.