Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

HealthCheckOptions Class

Definition

Namespace:
Microsoft.AspNetCore.Diagnostics.HealthChecks
Assembly:
Microsoft.AspNetCore.Diagnostics.HealthChecks.dll
Package:
Microsoft.AspNetCore.App.Ref v10.0.0
Package:
Microsoft.AspNetCore.App.Ref v11.0.0-preview.4.26230.115
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.36
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.19
Package:
Microsoft.AspNetCore.App.Ref v9.0.8
Source:
HealthCheckOptions.cs
Source:
HealthCheckOptions.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.

Contains options for the HealthCheckMiddleware.

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

Constructors

Name Description
HealthCheckOptions()

Properties

Name Description
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

Feedback

Was this page helpful?