RoutingEndpointConventionBuilderExtensions.WithGroupName<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.

Sets the EndpointGroupNameAttribute for all endpoints produced on the target IEndpointConventionBuilder given the endpointGroupName. The IEndpointGroupNameMetadata on the endpoint is used to set the endpoint's GroupName in the OpenAPI specification.

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

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

<Extension()>
Public Function WithGroupName(Of TBuilder As IEndpointConventionBuilder) (builder As TBuilder, endpointGroupName As String) As TBuilder

Type Parameters

TBuilder

Parameters

builder: TBuilder

The IEndpointConventionBuilder.

endpointGroupName: String

The endpoint group name.

Returns

TBuilder