Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
HealthCheckRegistration Class
Definition
- Assembly:
- Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions.dll
- Package:
- Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions v11.0.0-preview.5.26302.115
- Source:
- HealthCheckRegistration.cs
- Source:
- HealthCheckRegistration.cs
- Source:
- HealthCheckRegistration.cs
- Source:
- HealthCheckRegistration.cs
- Source:
- HealthCheckRegistration.cs
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represent the registration information associated with an IHealthCheck implementation.
public ref class HealthCheckRegistration sealedpublic sealed class HealthCheckRegistrationtype HealthCheckRegistration = classPublic NotInheritable Class HealthCheckRegistration- Inheritance
-
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
| Name | Description |
|---|---|
| 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
| Name | Description |
|---|---|
| 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. |
Applies to
Feedback
Was this page helpful?