Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

ForwardedHeadersExtensions.UseForwardedHeaders Method

Definition

Namespace:
Microsoft.AspNetCore.Builder
Assembly:
Microsoft.AspNetCore.HttpOverrides.dll
Package:
Microsoft.AspNetCore.HttpOverrides v1.0.0
Package:
Microsoft.AspNetCore.HttpOverrides v1.1.0
Package:
Microsoft.AspNetCore.App.Ref v10.0.0
Package:
Microsoft.AspNetCore.App.Ref v11.0.0-preview.4.26230.115
Package:
Microsoft.AspNetCore.HttpOverrides v2.0.0
Package:
Microsoft.AspNetCore.HttpOverrides v2.1.0
Package:
Microsoft.AspNetCore.HttpOverrides v2.2.0
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.

Overloads

Name Description
UseForwardedHeaders(IApplicationBuilder)

Applies forwarded headers to their matching fields on the current request.

By convention, HTTP proxies forward information from the client in well-known HTTP headers. The ForwardedHeadersMiddleware reads these headers and fills in the associated fields on HttpContext.

UseForwardedHeaders(IApplicationBuilder, ForwardedHeadersOptions)

Applies forwarded headers to their matching fields on the current request.

By convention, HTTP proxies forward information from the client in well-known HTTP headers. The ForwardedHeadersMiddleware reads these headers and fills in the associated fields on HttpContext.

UseForwardedHeaders(IApplicationBuilder)

Source:
ForwardedHeadersExtensions.cs
Source:
ForwardedHeadersExtensions.cs
Source:
ForwardedHeadersExtensions.cs

Applies forwarded headers to their matching fields on the current request.

By convention, HTTP proxies forward information from the client in well-known HTTP headers. The ForwardedHeadersMiddleware reads these headers and fills in the associated fields on HttpContext. 

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::AspNetCore::Builder::IApplicationBuilder ^ UseForwardedHeaders(Microsoft::AspNetCore::Builder::IApplicationBuilder ^ builder);
public static Microsoft.AspNetCore.Builder.IApplicationBuilder UseForwardedHeaders(this Microsoft.AspNetCore.Builder.IApplicationBuilder builder);
static member UseForwardedHeaders : Microsoft.AspNetCore.Builder.IApplicationBuilder -> Microsoft.AspNetCore.Builder.IApplicationBuilder
<Extension()>
Public Function UseForwardedHeaders (builder As IApplicationBuilder) As IApplicationBuilder

Parameters

Returns

A reference to builder after the operation has completed.

Applies to

UseForwardedHeaders(IApplicationBuilder, ForwardedHeadersOptions)

Source:
ForwardedHeadersExtensions.cs
Source:
ForwardedHeadersExtensions.cs
Source:
ForwardedHeadersExtensions.cs

Applies forwarded headers to their matching fields on the current request.

By convention, HTTP proxies forward information from the client in well-known HTTP headers. The ForwardedHeadersMiddleware reads these headers and fills in the associated fields on HttpContext. 

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::AspNetCore::Builder::IApplicationBuilder ^ UseForwardedHeaders(Microsoft::AspNetCore::Builder::IApplicationBuilder ^ builder, Microsoft::AspNetCore::Builder::ForwardedHeadersOptions ^ options);
public static Microsoft.AspNetCore.Builder.IApplicationBuilder UseForwardedHeaders(this Microsoft.AspNetCore.Builder.IApplicationBuilder builder, Microsoft.AspNetCore.Builder.ForwardedHeadersOptions options);
static member UseForwardedHeaders : Microsoft.AspNetCore.Builder.IApplicationBuilder * Microsoft.AspNetCore.Builder.ForwardedHeadersOptions -> Microsoft.AspNetCore.Builder.IApplicationBuilder
<Extension()>
Public Function UseForwardedHeaders (builder As IApplicationBuilder, options As ForwardedHeadersOptions) As IApplicationBuilder

Parameters

options
ForwardedHeadersOptions

Enables the different forwarding options.

Returns

A reference to builder after the operation has completed.

Applies to

Feedback

Was this page helpful?