Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
HealthCheckResult Struct
Definition
- Assembly:
- Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions.dll
- Package:
- Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions v11.0.0-preview.5.26302.115
- Source:
- HealthCheckResult.cs
- Source:
- HealthCheckResult.cs
- Source:
- HealthCheckResult.cs
- Source:
- HealthCheckResult.cs
- Source:
- HealthCheckResult.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.
Represents the result of a health check.
public value class HealthCheckResultpublic struct HealthCheckResulttype HealthCheckResult = structPublic Structure HealthCheckResult- Inheritance
Constructors
| Name | Description |
|---|---|
| HealthCheckResult(HealthStatus, String, Exception, IReadOnlyDictionary<String,Object>) |
Creates a new HealthCheckResult with the specified values for |
Properties
| Name | Description |
|---|---|
| Data |
Gets additional key-value pairs describing the health of the component. |
| Description |
Gets a human-readable description of the status of the component that was checked. |
| Exception |
Gets an Exception representing the exception that was thrown when checking for status (if any). |
| Status |
Gets a value indicating the status of the component that was checked. |
Methods
| Name | Description |
|---|---|
| Degraded(String, Exception, IReadOnlyDictionary<String,Object>) |
Creates a HealthCheckResult representing a degraded component. |
| Healthy(String, IReadOnlyDictionary<String,Object>) |
Creates a HealthCheckResult representing a healthy component. |
| Unhealthy(String, Exception, IReadOnlyDictionary<String,Object>) |
Creates a HealthCheckResult representing an unhealthy component. |
Applies to
Feedback
Was this page helpful?