Note

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

Access to this page requires authorization. You can try .

HealthCheckEndpointRouteBuilderExtensions.MapHealthChecks Method

Definition

Namespace:
Microsoft.AspNetCore.Builder
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.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

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.

Overloads

Name Description
MapHealthChecks(IEndpointRouteBuilder, String)

Adds a health checks endpoint to the IEndpointRouteBuilder with the specified template.
MapHealthChecks(IEndpointRouteBuilder, String, HealthCheckOptions)

Adds a health checks endpoint to the IEndpointRouteBuilder with the specified template and options.

MapHealthChecks(IEndpointRouteBuilder, String)

Source:
HealthCheckEndpointRouteBuilderExtensions.cs

Adds a health checks endpoint to the IEndpointRouteBuilder with the specified template.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::AspNetCore::Builder::IEndpointConventionBuilder ^ MapHealthChecks(Microsoft::AspNetCore::Routing::IEndpointRouteBuilder ^ endpoints, System::String ^ pattern);
public static Microsoft.AspNetCore.Builder.IEndpointConventionBuilder MapHealthChecks(this Microsoft.AspNetCore.Routing.IEndpointRouteBuilder endpoints, string pattern);
static member MapHealthChecks : Microsoft.AspNetCore.Routing.IEndpointRouteBuilder * string -> Microsoft.AspNetCore.Builder.IEndpointConventionBuilder
<Extension()>
Public Function MapHealthChecks (endpoints As IEndpointRouteBuilder, pattern As String) As IEndpointConventionBuilder

Parameters

endpoints
IEndpointRouteBuilder

The IEndpointRouteBuilder to add the health checks endpoint to.

pattern
String

The URL pattern of the health checks endpoint.

Returns

A convention routes for the health checks endpoint.

Applies to

MapHealthChecks(IEndpointRouteBuilder, String, HealthCheckOptions)

Source:
HealthCheckEndpointRouteBuilderExtensions.cs

Adds a health checks endpoint to the IEndpointRouteBuilder with the specified template and options.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::AspNetCore::Builder::IEndpointConventionBuilder ^ MapHealthChecks(Microsoft::AspNetCore::Routing::IEndpointRouteBuilder ^ endpoints, System::String ^ pattern, Microsoft::AspNetCore::Diagnostics::HealthChecks::HealthCheckOptions ^ options);
public static Microsoft.AspNetCore.Builder.IEndpointConventionBuilder MapHealthChecks(this Microsoft.AspNetCore.Routing.IEndpointRouteBuilder endpoints, string pattern, Microsoft.AspNetCore.Diagnostics.HealthChecks.HealthCheckOptions options);
static member MapHealthChecks : Microsoft.AspNetCore.Routing.IEndpointRouteBuilder * string * Microsoft.AspNetCore.Diagnostics.HealthChecks.HealthCheckOptions -> Microsoft.AspNetCore.Builder.IEndpointConventionBuilder
<Extension()>
Public Function MapHealthChecks (endpoints As IEndpointRouteBuilder, pattern As String, options As HealthCheckOptions) As IEndpointConventionBuilder

Parameters

endpoints
IEndpointRouteBuilder

The IEndpointRouteBuilder to add the health checks endpoint to.

pattern
String

The URL pattern of the health checks endpoint.

options
HealthCheckOptions

A HealthCheckOptions used to configure the health checks.

Returns

A convention routes for the health checks endpoint.

Applies to

Feedback

Was this page helpful?