RoutingEndpointConventionBuilderExtensions.WithName<TBuilder> Method

Reference

Definition

Namespace:: Microsoft.AspNetCore.Builder

Assembly:: Microsoft.AspNetCore.Routing.dll

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 the IEndpointNameMetadata to the Metadata collection for all endpoints produced on the target IEndpointConventionBuilder given the endpointName. The IEndpointNameMetadata on the endpoint is used for link generation and is treated as the operation ID in the given endpoint's OpenAPI specification.

public static TBuilder WithName<TBuilder> (this TBuilder builder, string endpointName) where TBuilder : Microsoft.AspNetCore.Builder.IEndpointConventionBuilder;

static member WithName : 'Builder * string -> 'Builder (requires 'Builder :> Microsoft.AspNetCore.Builder.IEndpointConventionBuilder)

<Extension()>
Public Function WithName(Of TBuilder As IEndpointConventionBuilder) (builder As TBuilder, endpointName As String) As TBuilder

Type Parameters

TBuilder

Parameters

builder: TBuilder

The IEndpointConventionBuilder.

endpointName: String

The endpoint name.

Returns

TBuilder