HealthCheckOptions.AllowCachingResponses Property

Definition

Namespace:

Microsoft.AspNetCore.Diagnostics.HealthChecks

Assembly:

Microsoft.AspNetCore.Diagnostics.HealthChecks.dll

Package:

Microsoft.AspNetCore.App.Ref v8.0.0

Source:

HealthCheckOptions.cs

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

Boolean

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.