HealthCheckResult.Degraded Method
Definition
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.
Creates a HealthCheckResult representing a degraded component.
public static Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult Degraded (string? description = default, Exception? exception = default, System.Collections.Generic.IReadOnlyDictionary<string,object>? data = default);static member Degraded : string * Exception * System.Collections.Generic.IReadOnlyDictionary<string, obj> -> Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResultPublic Shared Function Degraded (Optional description As String = Nothing, Optional exception As Exception = Nothing, Optional data As IReadOnlyDictionary(Of String, Object) = Nothing) As HealthCheckResultParameters
- description
- String
A human-readable description of the status of the component that was checked. Optional.
- exception
- Exception
An Exception representing the exception that was thrown when checking for status. Optional.
- data
- IReadOnlyDictionary<String,Object>
Additional key-value pairs describing the health of the component. Optional.
Returns
A HealthCheckResult representing a degraged component.
Applies to
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
