Microsoft.AspNetCore.Builder Namespace
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.
Contains methods for adding built-in middleware to an application, and the options types for the middleware.
Classes
ApplicationBuilder |
Default implementation for IApplicationBuilder. |
ApplicationBuilderExtensions |
Extension methods for adding the RequestLocalizationMiddleware to an application. |
AuthAppBuilderExtensions |
Extension methods to add authentication capabilities to an HTTP application pipeline. |
AuthenticationOptions |
Base Options for all authentication middleware. |
AuthorizationAppBuilderExtensions |
Extension methods to add authorization capabilities to an HTTP application pipeline. |
AuthorizationEndpointConventionBuilderExtensions |
Authorization extension methods for IEndpointConventionBuilder. |
BrowserLinkExtensions |
Implementation of extension methods for configuring Browser Link in an ASP.NET Core application. |
BuilderExtensions |
Identity extensions for IApplicationBuilder. |
CertificateForwardingBuilderExtensions |
Extension methods for using certificate forwarding. |
ClaimsTransformationAppBuilderExtensions |
Extension methods to add claims transformation capabilities to an HTTP application pipeline. |
ClaimsTransformationOptions |
Contains the options used by the ClaimsTransformationMiddleware. |
ComponentEndpointConventionBuilder |
Builds conventions that will be used for customization of ComponentHub EndpointBuilder instances. |
ComponentEndpointRouteBuilderExtensions |
Extensions for IEndpointRouteBuilder. |
ComponentsWebAssemblyApplicationBuilderExtensions |
Extensions for mapping Blazor WebAssembly applications. |
ComponentTypeMetadata |
Metadata that represents the component associated with an endpoint. |
ConcurrencyLimiterExtensions |
Extension methods for adding the ConcurrencyLimiterMiddleware to an application. |
ConfigureHostBuilder |
A non-buildable IHostBuilder for WebApplicationBuilder. Use Build() to build the WebApplicationBuilder. |
ConfigureWebHostBuilder |
A non-buildable IWebHostBuilder for WebApplicationBuilder. Use Build() to build the WebApplicationBuilder. |
ConnectionEndpointRouteBuilder |
Builds conventions that will be used for customization of Connection EndpointBuilder instances. |
ConnectionEndpointRouteBuilderExtensions |
Extension methods on IEndpointRouteBuilder that add routes for ConnectionHandlers. |
ConnectionsAppBuilderExtensions |
Extension methods for IApplicationBuilder. |
ControllerActionEndpointConventionBuilder |
Builds conventions that will be used for customization of EndpointBuilder instances. |
ControllerEndpointRouteBuilderExtensions |
Contains extension methods for using Controllers with IEndpointRouteBuilder. |
CookieAppBuilderExtensions |
Extension methods to add cookie authentication capabilities to an HTTP application pipeline. |
CookieAuthenticationOptions |
Configuration options for CookieAuthenticationMiddleware. |
CookiePolicyAppBuilderExtensions |
Extension methods to add cookie policy capabilities to an HTTP application pipeline. |
CookiePolicyOptions |
Provides programmatic configuration for the CookiePolicyMiddleware. |
CorsEndpointConventionBuilderExtensions |
CORS extension methods for IEndpointConventionBuilder. |
CorsMiddlewareExtensions |
The IApplicationBuilder extensions for adding CORS middleware support. |
DatabaseErrorPageExtensions |
IApplicationBuilder extension methods for the DatabaseErrorPageMiddleware. |
DatabaseErrorPageOptions |
Options for the DatabaseErrorPageMiddleware. |
DefaultFilesExtensions |
Extension methods for the DefaultFilesMiddleware |
DefaultFilesOptions |
Options for selecting default file names. |
DeveloperExceptionPageExtensions |
IApplicationBuilder extension methods for the DeveloperExceptionPageMiddleware. |
DeveloperExceptionPageOptions |
Options for the DeveloperExceptionPageMiddleware. |
DirectoryBrowserExtensions |
Extension methods for the DirectoryBrowserMiddleware |
DirectoryBrowserOptions |
Directory browsing options |
ElmExtensions | |
EndpointBuilder |
A base class for building an new Endpoint. |
EndpointRouteBuilderExtensions |
Provides extension methods for IEndpointRouteBuilder to add endpoints. |
EndpointRoutingApplicationBuilderExtensions |
Constains extensions for configuring routing on an IApplicationBuilder. |
ExceptionHandlerExtensions |
Extension methods for enabling ExceptionHandlerExtensions. |
ExceptionHandlerOptions |
Options for configuring the ExceptionHandlerMiddleware. |
FacebookAppBuilderExtensions |
Extension methods to add Facebook authentication capabilities to an HTTP application pipeline. |
FacebookOptions |
Configuration options for FacebookMiddleware. |
FallbackEndpointRouteBuilderExtensions |
Contains extension methods for IEndpointRouteBuilder. |
FileServerExtensions |
Extension methods that combine all of the static file middleware components: Default files, directory browsing, send file, and static files |
FileServerOptions |
Options for all of the static file middleware components |
ForwardedHeadersExtensions |
Extension methods for enabling ForwardedHeadersMiddleware. |
ForwardedHeadersOptions |
Options for ForwardedHeadersMiddleware |
GoogleAppBuilderExtensions |
Extension methods to add Google authentication capabilities to an HTTP application pipeline. |
GoogleOptions |
Configuration options for GoogleMiddleware. |
HeaderPropagationApplicationBuilderExtensions |
IApplicationBuilder extension methods for HeaderPropagationMiddleware which propagates request headers to an HttpClient. |
HealthCheckApplicationBuilderExtensions |
IApplicationBuilder extension methods for the HealthCheckMiddleware. |
HealthCheckEndpointRouteBuilderExtensions |
Provides extension methods for IEndpointRouteBuilder to add health checks. |
HostFilteringBuilderExtensions |
Extension methods for the HostFiltering middleware. |
HostFilteringServicesExtensions |
Extension methods for the host filtering middleware. |
HstsBuilderExtensions |
Extension methods for the HSTS middleware. |
HstsServicesExtensions |
Extension methods for the HSTS middleware. |
HttpLoggingBuilderExtensions |
Extension methods for the HttpLogging middleware. |
HttpMethodOverrideExtensions |
Extension methods for enabling HttpMethodOverrideMiddleware. |
HttpMethodOverrideOptions |
Options for configuring HttpMethodOverrideMiddleware |
HttpsPolicyBuilderExtensions |
Extension methods for the HttpsRedirection middleware. |
HttpsRedirectionServicesExtensions |
Extension methods for the HttpsRedirection middleware. |
HubEndpointConventionBuilder |
Builds conventions that will be used for customization of Hub EndpointBuilder instances. |
HubEndpointRouteBuilderExtensions |
Extension methods on IEndpointRouteBuilder to add routes to Hubs. |
IdentityOptions |
Represents all the options you can use to configure the identity system. |
IISOptions |
Options to configure IIS Out-Of-Process. |
IISServerOptions |
Provides configuration for IIS In-Process. |
JwtBearerAppBuilderExtensions |
Extension methods to add OpenIdConnect Bearer authentication capabilities to an HTTP application pipeline. |
JwtBearerOptions |
Options class provides information needed to control Bearer Authentication middleware behavior |
MapExtensions |
Extension methods for the MapMiddleware. |
MapRouteRouteBuilderExtensions |
Provides extension methods for IRouteBuilder to add routes. |
MapWhenExtensions |
Extension methods for the MapWhenMiddleware. |
MicrosoftAccountAppBuilderExtensions |
Extension methods to add Microsoft Account authentication capabilities to an HTTP application pipeline. |
MicrosoftAccountOptions |
Configuration options for MicrosoftAccountMiddleware. |
MigrationsEndPointExtensions |
IApplicationBuilder extension methods for the MigrationsEndPointMiddleware. |
MigrationsEndPointOptions |
Options for the MigrationsEndPointMiddleware. |
MvcApplicationBuilderExtensions |
Extension methods for IApplicationBuilder to add MVC to the request execution pipeline. |
MvcAreaRouteBuilderExtensions |
Extension methods for IRouteBuilder. |
OAuthAppBuilderExtensions |
Extension methods to add OAuth 2.0 authentication capabilities to an HTTP application pipeline. |
OAuthOptions |
Configuration options for OAuthMiddleware<TOptions>. |
OpenApiEndpointConventionBuilderExtensions |
Extension methods for annotating OpenAPI descriptions on an Endpoint. |
OpenIdConnectAppBuilderExtensions |
Extension methods to add OpenID Connect authentication capabilities to an HTTP application pipeline. |
OpenIdConnectOptions |
Configuration options for OpenIdConnectMiddleware |
OutputCacheApplicationBuilderExtensions | |
OwinExtensions |
Extension methods to add OWIN to an HTTP application pipeline. |
PageActionEndpointConventionBuilder |
Builds conventions that will be used for customization of EndpointBuilder instances. |
ProxyExtension | |
ProxyOptions |
Options to configure host, scheme, and port settings |
RateLimiterApplicationBuilderExtensions |
Extension methods for the RateLimiting middleware. |
RateLimiterEndpointConventionBuilderExtensions |
Rate limiter extension methods for IEndpointConventionBuilder. |
RateLimiterServiceCollectionExtensions |
Extension methods for the RateLimiting middleware. |
RazorComponentEndpointConventionBuilder |
Builds conventions that will be used for customization of EndpointBuilder instances. |
RazorComponentsEndpointRouteBuilderExtensions | |
RazorPagesEndpointRouteBuilderExtensions |
Contains extension methods for using Razor Pages with IEndpointRouteBuilder. |
RemoteAuthenticationOptions |
Contains the options used by the RemoteAuthenticationHandler<TOptions>. |
RequestDecompressionBuilderExtensions |
Extension methods for the HTTP request decompression middleware. |
RequestLocalizationOptions |
Specifies options for the RequestLocalizationMiddleware. |
RequestLocalizationOptionsExtensions |
Extension methods for the RequestLocalizationOptions. |
RequestTimeoutsIApplicationBuilderExtensions |
Extension methods for the request timeouts middleware. |
RequestTimeoutsIEndpointConventionBuilderExtensions |
Request timeouts extension methods for IEndpointConventionBuilder. |
ResponseBufferingMiddlewareExtensions | |
ResponseCachingExtensions |
Extension methods for adding the ResponseCachingMiddleware to an application. |
ResponseCompressionBuilderExtensions |
Extension methods for the ResponseCompression middleware. |
ResponseCompressionServicesExtensions |
Extension methods for the ResponseCompression middleware. |
RewriteBuilderExtensions |
Extension methods for the RewriteMiddleware |
RouteHandlerBuilder |
Builds conventions that will be used for customization of MapAction EndpointBuilder instances. |
RouterMiddleware |
Middleware responsible for routing. |
RouteShortCircuitEndpointConventionBuilderExtensions |
Short circuit extension methods for IEndpointConventionBuilder. |
RoutingBuilderExtensions |
Extension methods for adding the RouterMiddleware middleware to an IApplicationBuilder. |
RoutingEndpointConventionBuilderExtensions |
Extension methods for adding routing metadata to endpoint instances using IEndpointConventionBuilder. |
RunExtensions |
Extension methods for adding terminal middleware. |
SessionMiddlewareExtensions |
Extension methods for adding the SessionMiddleware to an application. |
SessionOptions |
Represents the session state options for the application. |
SignalRAppBuilderExtensions |
Extension methods for IApplicationBuilder. |
SpaApplicationBuilderExtensions |
Provides extension methods used for configuring an application to host a client-side Single Page Application (SPA). |
SpaPrerenderingExtensions |
Extension methods for configuring prerendering of a Single Page Application. |
SpaPrerenderingOptions |
Represents options for the SPA prerendering middleware. |
SpaProxyingExtensions |
Extension methods for proxying requests to a local SPA development server during development. Not for use in production applications. |
SpaRouteExtensions |
Extension methods useful for configuring routing in a single-page application (SPA). |
StaticFileExtensions |
Extension methods for the StaticFileMiddleware |
StaticFileOptions |
Options for serving static files |
StaticFilesEndpointRouteBuilderExtensions |
Contains extension methods for using static files with endpoint routing. |
StatusCodePagesExtensions |
Extension methods for enabling StatusCodePagesMiddleware. |
StatusCodePagesOptions |
Options for StatusCodePagesMiddleware. |
TwitterAppBuilderExtensions |
Extension methods to add Twitter authentication capabilities to an HTTP application pipeline. |
TwitterOptions |
Options for the Twitter authentication middleware. |
UseExtensions |
Extension methods for adding middleware. |
UseMiddlewareExtensions |
Extension methods for adding typed middleware. |
UsePathBaseExtensions |
Extension methods for IApplicationBuilder. |
UseWhenExtensions |
Extension methods for IApplicationBuilder. |
WebApiCompatShimRouteBuilderExtensions | |
WebApplication |
The web application used to configure the HTTP pipeline, and routes. |
WebApplicationBuilder |
A builder for web applications and services. |
WebApplicationOptions |
Options for configuring the behavior for CreateBuilder(WebApplicationOptions). |
WebAssemblyNetDebugProxyAppBuilderExtensions |
Provides infrastructure for debugging Blazor WebAssembly applications. |
WebpackDevMiddleware |
Extension methods that can be used to enable Webpack dev middleware support. |
WebSocketMiddlewareExtensions |
IApplicationBuilder extension methods to add and configure WebSocketMiddleware. |
WebSocketOptions |
Configuration options for the WebSocketMiddleware. |
WelcomePageExtensions |
IApplicationBuilder extensions for the WelcomePageMiddleware. |
WelcomePageOptions |
Options for the WelcomePageMiddleware. |
Interfaces
IApplicationBuilder |
Defines a class that provides the mechanisms to configure an application's request pipeline. |
IEndpointConventionBuilder |
Builds conventions that will be used for customization of EndpointBuilder instances. |
IHubEndpointConventionBuilder |
Abstraction that builds conventions that will be used for customization of Hub EndpointBuilder instances. |
Remarks
For more information about using ASP.NET Core built-in middleware, see Built-in middleware.