HealthCheckRegistration Constructors

Definition

Namespace:

Microsoft.Extensions.Diagnostics.HealthChecks

Assembly:

Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions.dll

Package:

Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions v8.0.10

Overloads

HealthCheckRegistration(String, IHealthCheck, Nullable<HealthStatus>, IEnumerable<String>)	Creates a new HealthCheckRegistration for an existing IHealthCheck instance.
HealthCheckRegistration(String, Func<IServiceProvider,IHealthCheck>, Nullable<HealthStatus>, IEnumerable<String>)	Creates a new HealthCheckRegistration for an existing IHealthCheck instance.
HealthCheckRegistration(String, IHealthCheck, Nullable<HealthStatus>, IEnumerable<String>, Nullable<TimeSpan>)	Creates a new HealthCheckRegistration for an existing IHealthCheck instance.
HealthCheckRegistration(String, Func<IServiceProvider,IHealthCheck>, Nullable<HealthStatus>, IEnumerable<String>, Nullable<TimeSpan>)	Creates a new HealthCheckRegistration for an existing IHealthCheck instance.

HealthCheckRegistration(String, IHealthCheck, Nullable<HealthStatus>, IEnumerable<String>)

Creates a new HealthCheckRegistration for an existing IHealthCheck instance.

public:
 HealthCheckRegistration(System::String ^ name, Microsoft::Extensions::Diagnostics::HealthChecks::IHealthCheck ^ instance, Nullable<Microsoft::Extensions::Diagnostics::HealthChecks::HealthStatus> failureStatus, System::Collections::Generic::IEnumerable<System::String ^> ^ tags);

public HealthCheckRegistration (string name, Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck instance, Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus? failureStatus, System.Collections.Generic.IEnumerable<string>? tags);

new Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration : string * Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck * Nullable<Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus> * seq<string> -> Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration

Public Sub New (name As String, instance As IHealthCheck, failureStatus As Nullable(Of HealthStatus), tags As IEnumerable(Of String))

Parameters

name

String

The health check name.

instance

IHealthCheck

The IHealthCheck instance.

failureStatus

Nullable<HealthStatus>

The HealthStatus that should be reported upon failure of the health check. If the provided value is null, then Unhealthy will be reported.

tags

IEnumerable<String>

A list of tags that can be used for filtering health checks.

HealthCheckRegistration(String, Func<IServiceProvider,IHealthCheck>, Nullable<HealthStatus>, IEnumerable<String>)

Creates a new HealthCheckRegistration for an existing IHealthCheck instance.

public:
 HealthCheckRegistration(System::String ^ name, Func<IServiceProvider ^, Microsoft::Extensions::Diagnostics::HealthChecks::IHealthCheck ^> ^ factory, Nullable<Microsoft::Extensions::Diagnostics::HealthChecks::HealthStatus> failureStatus, System::Collections::Generic::IEnumerable<System::String ^> ^ tags);

public HealthCheckRegistration (string name, Func<IServiceProvider,Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck> factory, Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus? failureStatus, System.Collections.Generic.IEnumerable<string>? tags);

new Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration : string * Func<IServiceProvider, Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck> * Nullable<Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus> * seq<string> -> Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration

Public Sub New (name As String, factory As Func(Of IServiceProvider, IHealthCheck), failureStatus As Nullable(Of HealthStatus), tags As IEnumerable(Of String))

Parameters

name

String

The health check name.

factory

Func<IServiceProvider,IHealthCheck>

A delegate used to create the IHealthCheck instance.

failureStatus

Nullable<HealthStatus>

The HealthStatus that should be reported when the health check reports a failure. If the provided value is null, then Unhealthy will be reported.

tags

IEnumerable<String>

A list of tags that can be used for filtering health checks.

HealthCheckRegistration(String, IHealthCheck, Nullable<HealthStatus>, IEnumerable<String>, Nullable<TimeSpan>)

Creates a new HealthCheckRegistration for an existing IHealthCheck instance.

public:
 HealthCheckRegistration(System::String ^ name, Microsoft::Extensions::Diagnostics::HealthChecks::IHealthCheck ^ instance, Nullable<Microsoft::Extensions::Diagnostics::HealthChecks::HealthStatus> failureStatus, System::Collections::Generic::IEnumerable<System::String ^> ^ tags, Nullable<TimeSpan> timeout);

public HealthCheckRegistration (string name, Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck instance, Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus? failureStatus, System.Collections.Generic.IEnumerable<string>? tags, TimeSpan? timeout);

new Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration : string * Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck * Nullable<Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus> * seq<string> * Nullable<TimeSpan> -> Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration

Public Sub New (name As String, instance As IHealthCheck, failureStatus As Nullable(Of HealthStatus), tags As IEnumerable(Of String), timeout As Nullable(Of TimeSpan))

Parameters

name

String

The health check name.

instance

IHealthCheck

The IHealthCheck instance.

failureStatus

Nullable<HealthStatus>

The HealthStatus that should be reported upon failure of the health check. If the provided value is null, then Unhealthy will be reported.

tags

IEnumerable<String>

A list of tags that can be used for filtering health checks.

timeout

Nullable<TimeSpan>

An optional TimeSpan representing the timeout of the check.

HealthCheckRegistration(String, Func<IServiceProvider,IHealthCheck>, Nullable<HealthStatus>, IEnumerable<String>, Nullable<TimeSpan>)

Creates a new HealthCheckRegistration for an existing IHealthCheck instance.

public:
 HealthCheckRegistration(System::String ^ name, Func<IServiceProvider ^, Microsoft::Extensions::Diagnostics::HealthChecks::IHealthCheck ^> ^ factory, Nullable<Microsoft::Extensions::Diagnostics::HealthChecks::HealthStatus> failureStatus, System::Collections::Generic::IEnumerable<System::String ^> ^ tags, Nullable<TimeSpan> timeout);

public HealthCheckRegistration (string name, Func<IServiceProvider,Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck> factory, Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus? failureStatus, System.Collections.Generic.IEnumerable<string>? tags, TimeSpan? timeout);

new Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration : string * Func<IServiceProvider, Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck> * Nullable<Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus> * seq<string> * Nullable<TimeSpan> -> Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration

Public Sub New (name As String, factory As Func(Of IServiceProvider, IHealthCheck), failureStatus As Nullable(Of HealthStatus), tags As IEnumerable(Of String), timeout As Nullable(Of TimeSpan))

Parameters

name

String

The health check name.

factory

Func<IServiceProvider,IHealthCheck>

A delegate used to create the IHealthCheck instance.

failureStatus

Nullable<HealthStatus>

The HealthStatus that should be reported when the health check reports a failure. If the provided value is null, then Unhealthy will be reported.

tags

IEnumerable<String>

A list of tags that can be used for filtering health checks.

timeout

Nullable<TimeSpan>

An optional TimeSpan representing the timeout of the check.