HealthCheckRegistration Class

Definition

Namespace:

Microsoft.Extensions.Diagnostics.HealthChecks

Assembly:

Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions.dll

Package:

Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions v9.0.0

Source:

HealthCheckRegistration.cs

Represent the registration information associated with an IHealthCheck implementation.

public ref class HealthCheckRegistration sealed

public sealed class HealthCheckRegistration

type HealthCheckRegistration = class

Public NotInheritable Class HealthCheckRegistration

Inheritance

Object

HealthCheckRegistration

Remarks

The health check registration is provided as a separate object so that application developers can customize how health check implementations are configured.

The registration is provided to an IHealthCheck implementation during execution through Registration. This allows a health check implementation to access named options or perform other operations based on the registered name.

Constructors

HealthCheckRegistration(String, Func<IServiceProvider,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>)	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, IHealthCheck, Nullable<HealthStatus>, IEnumerable<String>)	Creates a new HealthCheckRegistration for an existing IHealthCheck instance.

Properties

Delay	Gets or sets the individual delay applied to the health check after the application starts before executing IHealthCheckPublisher instances. The delay is applied once at startup, and does not apply to subsequent iterations.
Factory	Gets or sets a delegate used to create the IHealthCheck instance.
FailureStatus	Gets or sets the HealthStatus that should be reported upon failure of the health check.
Name	Gets or sets the health check name.
Period	Gets or sets the individual period used for the check.
Tags	Gets a list of tags that can be used for filtering health checks.
Timeout	Gets or sets the timeout used for the test.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)