Class ApplicationBuilderExtensions
Extension methods for the Microsoft.AspNetCore.Builder.IApplicationBuilder interface.
Inheritance
Namespace: Cuemon.AspNetCore.Builder
Assembly: Cuemon.AspNetCore.dll
Syntax
public static class ApplicationBuilderExtensions
Methods
| Improve this DocUseCorrelationIdentifierHeader(IApplicationBuilder, Action<CorrelationIdentifierOptions>)
Adds a correlation identifier HTTP header to the Microsoft.AspNetCore.Builder.IApplicationBuilder request execution pipeline.
Declaration
public static IApplicationBuilder UseCorrelationIdentifierHeader(this IApplicationBuilder builder, Action<CorrelationIdentifierOptions> setup = null)
Parameters
Type | Name | Description |
---|---|---|
Microsoft.AspNetCore.Builder.IApplicationBuilder | builder | The type that provides the mechanisms to configure an application’s request pipeline. |
System.Action<CorrelationIdentifierOptions> | setup | The CorrelationIdentifierOptions middleware which need to be configured. |
Returns
Type | Description |
---|---|
Microsoft.AspNetCore.Builder.IApplicationBuilder | A reference to this instance after the operation has completed. |
Remarks
Default HTTP header name is X-Correlation-ID
.
UseCustomThrottlingSentinel(IApplicationBuilder, Action<ThrottlingSentinelOptions>)
Adds a custom rate limiting / throttling to the Microsoft.AspNetCore.Builder.IApplicationBuilder request execution pipeline.
Declaration
public static IApplicationBuilder UseCustomThrottlingSentinel(this IApplicationBuilder builder, Action<ThrottlingSentinelOptions> setup)
Parameters
Type | Name | Description |
---|---|---|
Microsoft.AspNetCore.Builder.IApplicationBuilder | builder | The type that provides the mechanisms to configure an application’s request pipeline. |
System.Action<ThrottlingSentinelOptions> | setup | The ThrottlingSentinelOptions middleware which need to be configured. |
Returns
Type | Description |
---|---|
Microsoft.AspNetCore.Builder.IApplicationBuilder | A reference to this instance after the operation has completed. |
UseHostingEnvironmentHeader(IApplicationBuilder, Action<HostingEnvironmentOptions>)
Adds a hosting environment HTTP header to the Microsoft.AspNetCore.Builder.IApplicationBuilder request execution pipeline.
Declaration
public static IApplicationBuilder UseHostingEnvironmentHeader(this IApplicationBuilder builder, Action<HostingEnvironmentOptions> setup = null)
Parameters
Type | Name | Description |
---|---|---|
Microsoft.AspNetCore.Builder.IApplicationBuilder | builder | The type that provides the mechanisms to configure an application’s request pipeline. |
System.Action<HostingEnvironmentOptions> | setup | The HostingEnvironmentOptions middleware which need to be configured. |
Returns
Type | Description |
---|---|
Microsoft.AspNetCore.Builder.IApplicationBuilder | A reference to this instance after the operation has completed. |
UseRequestIdentifierHeader(IApplicationBuilder, Action<RequestIdentifierOptions>)
Adds a request identifier HTTP header to the Microsoft.AspNetCore.Builder.IApplicationBuilder request execution pipeline.
Declaration
public static IApplicationBuilder UseRequestIdentifierHeader(this IApplicationBuilder builder, Action<RequestIdentifierOptions> setup = null)
Parameters
Type | Name | Description |
---|---|---|
Microsoft.AspNetCore.Builder.IApplicationBuilder | builder | The type that provides the mechanisms to configure an application’s request pipeline. |
System.Action<RequestIdentifierOptions> | setup | The RequestIdentifierOptions middleware which need to be configured. |
Returns
Type | Description |
---|---|
Microsoft.AspNetCore.Builder.IApplicationBuilder | A reference to this instance after the operation has completed. |
Remarks
Default HTTP header name is X-Request-ID
.
UseUserAgentSentinel(IApplicationBuilder, Action<UserAgentSentinelOptions>)
Adds a HTTP User-Agent header parser to the Microsoft.AspNetCore.Builder.IApplicationBuilder request execution pipeline.
Declaration
public static IApplicationBuilder UseUserAgentSentinel(this IApplicationBuilder builder, Action<UserAgentSentinelOptions> setup = null)
Parameters
Type | Name | Description |
---|---|---|
Microsoft.AspNetCore.Builder.IApplicationBuilder | builder | The type that provides the mechanisms to configure an application’s request pipeline. |
System.Action<UserAgentSentinelOptions> | setup | The UserAgentSentinelOptions middleware which need to be configured. |
Returns
Type | Description |
---|---|
Microsoft.AspNetCore.Builder.IApplicationBuilder | A reference to this instance after the operation has completed. |