HealthCheckService.CheckHealthAsync Метод

Определение

Пространство имен:

Microsoft.Extensions.Diagnostics.HealthChecks

Сборка:

Microsoft.Extensions.Diagnostics.HealthChecks.dll

Пакет:

Microsoft.Extensions.Diagnostics.HealthChecks v8.0.6

Перегрузки

CheckHealthAsync(CancellationToken)	Выполняет все проверки работоспособности в приложении и возвращает агрегированное состояние.
CheckHealthAsync(Func<HealthCheckRegistration,Boolean>, CancellationToken)	Выполняет предоставленные проверки работоспособности и возвращает агрегированное состояние.

CheckHealthAsync(CancellationToken)

Исходный код:

HealthCheckService.cs

Выполняет все проверки работоспособности в приложении и возвращает агрегированное состояние.

public System.Threading.Tasks.Task<Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport> CheckHealthAsync (System.Threading.CancellationToken cancellationToken = default);

member this.CheckHealthAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport>

Public Function CheckHealthAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of HealthReport)

Параметры

cancellationToken

CancellationToken

Токен CancellationToken, который можно использовать для отмены проверок работоспособности.

Возвращаемое значение

Task<HealthReport>

Задача Task<TResult>, которая завершится после выполнения всех проверок работоспособности и вернет объект HealthReport с результатами.

Исключения

OperationCanceledException

Маркер отмены был отменен. Это исключение сохраняется в возвращаемой задаче.

CheckHealthAsync(Func<HealthCheckRegistration,Boolean>, CancellationToken)

Исходный код:

HealthCheckService.cs

Выполняет предоставленные проверки работоспособности и возвращает агрегированное состояние.

public abstract System.Threading.Tasks.Task<Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport> CheckHealthAsync (Func<Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration,bool>? predicate, System.Threading.CancellationToken cancellationToken = default);

abstract member CheckHealthAsync : Func<Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration, bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport>

Public MustOverride Function CheckHealthAsync (predicate As Func(Of HealthCheckRegistration, Boolean), Optional cancellationToken As CancellationToken = Nothing) As Task(Of HealthReport)

Параметры

predicate

Func<HealthCheckRegistration,Boolean>

Предикат, который можно использовать для включения проверок работоспособности на основе определенных пользователем условий.

cancellationToken

CancellationToken

Токен CancellationToken, который можно использовать для отмены проверок работоспособности.

Возвращаемое значение

Task<HealthReport>

Задача Task<TResult>, которая завершится после выполнения всех проверок работоспособности и вернет объект HealthReport с результатами.

Исключения

OperationCanceledException

Маркер отмены был отменен. Это исключение сохраняется в возвращаемой задаче.