HealthCheckResult Constructor

Definition

Namespace:

Microsoft.Extensions.Diagnostics.HealthChecks

Assembly:

Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions.dll

Package:

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

Source:

HealthCheckResult.cs

Creates a new HealthCheckResult with the specified values for status, exception, description, and data.

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

new Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult : Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus * string * Exception * System.Collections.Generic.IReadOnlyDictionary<string, obj> -> Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult

Public Sub New (status As HealthStatus, Optional description As String = Nothing, Optional exception As Exception = Nothing, Optional data As IReadOnlyDictionary(Of String, Object) = Nothing)

Parameters

status

HealthStatus

A value indicating the status of the component that was checked.

description

String

A human-readable description of the status of the component that was checked.

exception

Exception

An Exception representing the exception that was thrown when checking for status (if any).

data

IReadOnlyDictionary<String,Object>

Additional key-value pairs describing the health of the component.