HealthCheckResult.Unhealthy メソッド

定義

名前空間:

Microsoft.Extensions.Diagnostics.HealthChecks

アセンブリ:

Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions.dll

パッケージ:

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

ソース:

HealthCheckResult.cs

異常なコンポーネントを表す HealthCheckResult を作成します。

public static Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult Unhealthy (string? description = default, Exception? exception = default, System.Collections.Generic.IReadOnlyDictionary<string,object>? data = default);

static member Unhealthy : string * Exception * System.Collections.Generic.IReadOnlyDictionary<string, obj> -> Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult

Public Shared Function Unhealthy (Optional description As String = Nothing, Optional exception As Exception = Nothing, Optional data As IReadOnlyDictionary(Of String, Object) = Nothing) As HealthCheckResult

パラメーター

description

String

チェック対象のコンポーネントの状態を示す、人が判読できる説明。 省略可能。

exception

Exception

状態をチェックするときにスローされた例外を表す Exception。 省略可能。

data

IReadOnlyDictionary<String,Object>

コンポーネントの正常性を説明する追加のキーと値のペア。 省略可能。

戻り値

HealthCheckResult

異常なコンポーネントを表す HealthCheckResult。