Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
IEndpointConventionBuilder Interface
Definition
- Namespace:
- Microsoft.AspNetCore.Builder
- Assembly:
- Microsoft.AspNetCore.Http.Abstractions.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.
Builds conventions that will be used for customization of EndpointBuilder instances.
public interface class IEndpointConventionBuilderpublic interface IEndpointConventionBuildertype IEndpointConventionBuilder = interfacePublic Interface IEndpointConventionBuilder- Derived
Remarks
This interface is used at application startup to customize endpoints for the application.
Methods
| Name | Description |
|---|---|
| Add(Action<EndpointBuilder>) |
Adds the specified convention to the builder. Conventions are used to customize EndpointBuilder instances. |
| Finally(Action<EndpointBuilder>) |
Registers the specified convention for execution after conventions registered via Add(Action<EndpointBuilder>) |
Extension Methods
| Name | Description |
|---|---|
| DisableRequestTimeout(IEndpointConventionBuilder) |
Disables request timeout on the endpoint(s). |
| ShortCircuit(IEndpointConventionBuilder, Nullable<Int32>) |
Short circuit the endpoint(s). The execution of the endpoint will happen in UseRouting middleware instead of UseEndpoint. |
| WithRequestTimeout(IEndpointConventionBuilder, RequestTimeoutPolicy) |
Specifies a timeout policy for to the endpoint(s). |
| WithRequestTimeout(IEndpointConventionBuilder, String) |
Specifies a timeout policy for to the endpoint(s). |
| WithRequestTimeout(IEndpointConventionBuilder, TimeSpan) |
Specifies a timeout for the endpoint(s). |
Applies to
Feedback
Was this page helpful?