HealthCheckOptions Class

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Diagnostics.HealthChecks
Assembly:
Microsoft.AspNetCore.Diagnostics.HealthChecks.dll
Package:
Microsoft.AspNetCore.Diagnostics.HealthChecks v2.2.0
Package:
Microsoft.AspNetCore.App.Ref v3.0.1
Package:
Microsoft.AspNetCore.App.Ref v3.1.10
Package:
Microsoft.AspNetCore.App.Ref v5.0.0
Package:
Microsoft.AspNetCore.App.Ref v6.0.6
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.0
Package:
Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3
Source:
HealthCheckOptions.cs
Source:
HealthCheckOptions.cs

Contains options for the HealthCheckMiddleware.

public ref class HealthCheckOptions
public class HealthCheckOptions
type HealthCheckOptions = class
Public Class HealthCheckOptions
Inheritance
Object
HealthCheckOptions

Constructors

HealthCheckOptions()

Properties

AllowCachingResponses

Gets or sets a value that controls whether responses from the health check middleware can be cached.
Predicate

Gets or sets a predicate that is used to filter the set of health checks executed.
ResponseWriter

Gets or sets a delegate used to write the response.
ResultStatusCodes

Gets or sets a dictionary mapping the HealthStatus to an HTTP status code applied to the response. This property can be used to configure the status codes returned for each status.

Applies to