HealthCheckService.CheckHealthAsync メソッド

定義

名前空間:

Microsoft.Extensions.Diagnostics.HealthChecks

アセンブリ:

Microsoft.Extensions.Diagnostics.HealthChecks.dll

パッケージ:

Microsoft.Extensions.Diagnostics.HealthChecks v9.0.0

オーバーロード

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

キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。