IHealthCheck.CheckHealthAsync(HealthCheckContext, CancellationToken) メソッド

リファレンス

定義

名前空間:: Microsoft.Extensions.Diagnostics.HealthChecks

アセンブリ:: Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions.dll

パッケージ:: Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions v8.0.10

パッケージ:: Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions v9.0.0-rc.2.24474.3

ソース:: IHealthCheck.cs

ソース:: IHealthCheck.cs

ソース:: IHealthCheck.cs

ソース:: IHealthCheck.cs

ソース:: IHealthCheck.cs

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

正常性チェックを実行します。これにより、チェック対象のコンポーネントの状態が返されます。

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)

パラメーター

context: HealthCheckContext

現在の実行に関連付けられているコンテキストオブジェクト。

cancellationToken: CancellationToken

正常性チェックをキャンセルするために使用できる CancellationToken。

戻り値

Task<HealthCheckResult>

正常性チェックが終了したときに完了する Task<TResult>。これにより、チェック対象のコンポーネントの状態が生成されます。

例外

OperationCanceledException

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

適用対象