CommonHealthChecksExtensions.ReportUnhealthy Method

Definition

Sets the manual health check to return an unhealthy states and an associated reason.

public:
[System::Runtime::CompilerServices::Extension]
 static void ReportUnhealthy(Microsoft::Extensions::Diagnostics::HealthChecks::IManualHealthCheck ^ manualHealthCheck, System::String ^ reason);
public static void ReportUnhealthy (this Microsoft.Extensions.Diagnostics.HealthChecks.IManualHealthCheck manualHealthCheck, string reason);
static member ReportUnhealthy : Microsoft.Extensions.Diagnostics.HealthChecks.IManualHealthCheck * string -> unit
<Extension()>
Public Sub ReportUnhealthy (manualHealthCheck As IManualHealthCheck, reason As String)

Parameters

manualHealthCheck
IManualHealthCheck

The IManualHealthCheck.

reason
String

The reason why the health check is unhealthy.

Exceptions

manualHealthCheck is null.

Applies to