HealthCheckService.CheckHealthAsync 方法

定義

命名空間:

Microsoft.Extensions.Diagnostics.HealthChecks

組件:

Microsoft.Extensions.Diagnostics.HealthChecks.dll

套件:

Microsoft.Extensions.Diagnostics.HealthChecks v8.0.4

多載

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

取消令牌已取消。 此例外狀況會儲存在傳回的工作中。