IHealthCheck.CheckHealthAsync(HealthCheckContext, CancellationToken) Method

Definition

Runs the health check, returning the status of the component being checked.

public System.Threading.Tasks.Task<Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult> CheckHealthAsync (Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckContext context, System.Threading.CancellationToken cancellationToken = default);
abstract member CheckHealthAsync : Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult>
Public Function CheckHealthAsync (context As HealthCheckContext, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HealthCheckResult)

Parameters

context
HealthCheckContext

A context object associated with the current execution.

cancellationToken
CancellationToken

A CancellationToken that can be used to cancel the health check.

Returns

A Task<TResult> that completes when the health check has finished, yielding the status of the component being checked.

Exceptions

The cancellation token was canceled. This exception is stored into the returned task.

Applies to