IManualHealthCheck Interface

Reference

Definition

Namespace:: Microsoft.Extensions.Diagnostics.HealthChecks

Assembly:: Microsoft.Extensions.Diagnostics.HealthChecks.Common.dll

Package:: Microsoft.Extensions.Diagnostics.HealthChecks.Common v9.2.0

Source:: IManualHealthCheck.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.

Lets you manually set the health status of the application.

public interface class IManualHealthCheck : IDisposable

public interface IManualHealthCheck : IDisposable

type IManualHealthCheck = interface
    interface IDisposable

Public Interface IManualHealthCheck
Implements IDisposable

Derived: Microsoft.Extensions.Diagnostics.HealthChecks.IManualHealthCheck<T>

Implements: IDisposable

Properties

Result

Gets or sets the health status.

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

(Inherited from IDisposable)

Extension Methods

ReportHealthy(IManualHealthCheck)	Sets the manual health check to the healthy state.
ReportUnhealthy(IManualHealthCheck, String)	Sets the manual health check to return an unhealthy states and an associated reason.

Applies to

Product	Versions
.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)

Share via