Note

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

Access to this page requires authorization. You can try .

HealthCheckOptions.AllowCachingResponses Property

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.

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

public:
 property bool AllowCachingResponses { bool get(); void set(bool value); };
public bool AllowCachingResponses { get; set; }
member this.AllowCachingResponses : bool with get, set
Public Property AllowCachingResponses As Boolean

Property Value

Remarks

The health check middleware does not perform caching of any kind. This setting configures whether the middleware will apply headers to the HTTP response that instruct clients to avoid caching.

If the value is false the health check middleware will set or override the Cache-Control, Expires, and Pragma headers to prevent response caching. If the value is true the health check middleware will not modify the cache headers of the response.

Applies to

Feedback

Was this page helpful?