Note

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

Access to this page requires authorization. You can try .

HealthCheckOptions.Predicate 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 predicate that is used to filter the set of health checks executed.

public:
 property Func<Microsoft::Extensions::Diagnostics::HealthChecks::HealthCheckRegistration ^, bool> ^ Predicate { Func<Microsoft::Extensions::Diagnostics::HealthChecks::HealthCheckRegistration ^, bool> ^ get(); void set(Func<Microsoft::Extensions::Diagnostics::HealthChecks::HealthCheckRegistration ^, bool> ^ value); };
public Func<Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration,bool>? Predicate { get; set; }
public Func<Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration,bool> Predicate { get; set; }
member this.Predicate : Func<Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration, bool> with get, set
Public Property Predicate As Func(Of HealthCheckRegistration, Boolean)

Property Value

Remarks

If Predicate is null, the HealthCheckMiddleware will run all registered health checks - this is the default behavior. To run a subset of health checks, provide a function that filters the set of checks.

Applies to

Feedback

Was this page helpful?