IHealthCheck.CheckHealthAsync(HealthCheckContext, CancellationToken) Método

Definição

Namespace:

Microsoft.Extensions.Diagnostics.HealthChecks

Assembly:

Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions.dll

Pacote:

Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions v8.0.0

Origem:

IHealthCheck.cs

Executa a verificação de integridade, retornando o status do componente que está sendo verificado.

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)

Parâmetros

context

HealthCheckContext

Um objeto de contexto associado à execução atual.

cancellationToken

CancellationToken

Um CancellationToken que pode ser usado para cancelar a verificação de integridade.

Retornos

Task<HealthCheckResult>

Uma Task<TResult> que é concluída quando a verificação de integridade é concluída, produzindo o status do componente que está sendo verificado.

Exceções

OperationCanceledException

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.