Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

HealthCheckResult.Unhealthy Method

Definition

Namespace:
Microsoft.Extensions.Diagnostics.HealthChecks
Assembly:
Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions.dll
Package:
Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions v11.0.0-preview.5.26302.115
Source:
HealthCheckResult.cs
Source:
HealthCheckResult.cs
Source:
HealthCheckResult.cs
Source:
HealthCheckResult.cs
Source:
HealthCheckResult.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

A HealthCheckResult representing an unhealthy component.

Applies to

Feedback

Was this page helpful?