HealthCheckEndpointRouteBuilderExtensions.MapHealthChecks Method

Definition

Namespace:

Microsoft.AspNetCore.Builder

Assembly:

Microsoft.AspNetCore.Diagnostics.HealthChecks.dll

Package:

Microsoft.AspNetCore.App.Ref v8.0.0

Overloads

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)

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

IEndpointConventionBuilder

A convention routes for the health checks endpoint.

MapHealthChecks(IEndpointRouteBuilder, String, HealthCheckOptions)

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

IEndpointConventionBuilder

A convention routes for the health checks endpoint.