ControllerEndpointRouteBuilderExtensions.MapControllerRoute Method

Reference

Definition

Namespace:: Microsoft.AspNetCore.Builder

Assembly:: Microsoft.AspNetCore.Mvc.Core.dll

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.6

Package:: Microsoft.AspNetCore.App.Ref v7.0.5

Package:: Microsoft.AspNetCore.App.Ref v8.0.0

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.

Adds endpoints for controller actions to the IEndpointRouteBuilder and specifies a route with the given name, pattern, defaults, constraints, and dataTokens.

public static Microsoft.AspNetCore.Builder.ControllerActionEndpointConventionBuilder MapControllerRoute (this Microsoft.AspNetCore.Routing.IEndpointRouteBuilder endpoints, string name, string pattern, object defaults = default, object constraints = default, object dataTokens = default);

public static Microsoft.AspNetCore.Builder.ControllerActionEndpointConventionBuilder MapControllerRoute (this Microsoft.AspNetCore.Routing.IEndpointRouteBuilder endpoints, string name, string pattern, object? defaults = default, object? constraints = default, object? dataTokens = default);

static member MapControllerRoute : Microsoft.AspNetCore.Routing.IEndpointRouteBuilder * string * string * obj * obj * obj -> Microsoft.AspNetCore.Builder.ControllerActionEndpointConventionBuilder

<Extension()>
Public Function MapControllerRoute (endpoints As IEndpointRouteBuilder, name As String, pattern As String, Optional defaults As Object = Nothing, Optional constraints As Object = Nothing, Optional dataTokens As Object = Nothing) As ControllerActionEndpointConventionBuilder

Parameters

endpoints: IEndpointRouteBuilder

The IEndpointRouteBuilder to add the route to.

name: String

The name of the route.

pattern: String

The URL pattern of the route.

defaults: Object

An object that contains default values for route parameters. The object's properties represent the names and values of the default values.

constraints: Object

An object that contains constraints for the route. The object's properties represent the names and values of the constraints.

dataTokens: Object

An object that contains data tokens for the route. The object's properties represent the names and values of the data tokens.

Returns

ControllerActionEndpointConventionBuilder

An ControllerActionEndpointConventionBuilder for endpoints associated with controller actions for this route.

Applies to