HealthCheckResult.Unhealthy Method
Definition
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);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.HealthCheckResultPublic Shared Function Unhealthy (Optional description As String = Nothing, Optional exception As Exception = Nothing, Optional data As IReadOnlyDictionary(Of String, Object) = Nothing) As HealthCheckResultParameters
- 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
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for