HeaderPropagationEntryCollection.Add Method

Reference

Definition

Namespace:: Microsoft.AspNetCore.HeaderPropagation

Assembly:: Microsoft.AspNetCore.HeaderPropagation.dll

Package:: Microsoft.AspNetCore.HeaderPropagation v3.0.3

Package:: Microsoft.AspNetCore.HeaderPropagation v3.1.18

Package:: Microsoft.AspNetCore.HeaderPropagation v5.0.9

Package:: Microsoft.AspNetCore.HeaderPropagation v6.0.6

Package:: Microsoft.AspNetCore.HeaderPropagation v7.0.0-preview.5.22303.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

Add(String)	Adds an HeaderPropagationEntry that will use `headerName` as the value of InboundHeaderName and CapturedHeaderName.
Add(String, Func<HeaderPropagationContext,StringValues>)	Adds an HeaderPropagationEntry that will use `headerName` as the value of InboundHeaderName and CapturedHeaderName.
Add(String, String)	Adds an HeaderPropagationEntry that will use the provided `inboundHeaderName` and `outboundHeaderName`.
Add(String, String, Func<HeaderPropagationContext,StringValues>)	Adds an HeaderPropagationEntry that will use the provided `inboundHeaderName`, `outboundHeaderName`, and `valueFilter`.

Add(String)

Adds an HeaderPropagationEntry that will use headerName as the value of InboundHeaderName and CapturedHeaderName.

public:
 void Add(System::String ^ headerName);

public void Add (string headerName);

override this.Add : string -> unit

Public Sub Add (headerName As String)

Parameters

headerName: String

The header name to be propagated.

Applies to

Add(String, Func<HeaderPropagationContext,StringValues>)

Adds an HeaderPropagationEntry that will use headerName as the value of InboundHeaderName and CapturedHeaderName.

public:
 void Add(System::String ^ headerName, Func<Microsoft::AspNetCore::HeaderPropagation::HeaderPropagationContext, Microsoft::Extensions::Primitives::StringValues> ^ valueFilter);

public void Add (string headerName, Func<Microsoft.AspNetCore.HeaderPropagation.HeaderPropagationContext,Microsoft.Extensions.Primitives.StringValues> valueFilter);

override this.Add : string * Func<Microsoft.AspNetCore.HeaderPropagation.HeaderPropagationContext, Microsoft.Extensions.Primitives.StringValues> -> unit

Public Sub Add (headerName As String, valueFilter As Func(Of HeaderPropagationContext, StringValues))

Parameters

headerName: String

The header name to be propagated.

valueFilter: Func<HeaderPropagationContext,StringValues>

A filter delegate that can be used to transform the header value. See ValueFilter.

Applies to

Add(String, String)

Adds an HeaderPropagationEntry that will use the provided inboundHeaderName and outboundHeaderName.

public:
 void Add(System::String ^ inboundHeaderName, System::String ^ outboundHeaderName);

public void Add (string inboundHeaderName, string outboundHeaderName);

override this.Add : string * string -> unit

Public Sub Add (inboundHeaderName As String, outboundHeaderName As String)

Parameters

inboundHeaderName: String

The name of the header to be captured by HeaderPropagationMiddleware.

outboundHeaderName: String

The name of the header to be added by HeaderPropagationMessageHandler.

Applies to

Add(String, String, Func<HeaderPropagationContext,StringValues>)

Adds an HeaderPropagationEntry that will use the provided inboundHeaderName, outboundHeaderName, and valueFilter.

public:
 void Add(System::String ^ inboundHeaderName, System::String ^ outboundHeaderName, Func<Microsoft::AspNetCore::HeaderPropagation::HeaderPropagationContext, Microsoft::Extensions::Primitives::StringValues> ^ valueFilter);

public void Add (string inboundHeaderName, string outboundHeaderName, Func<Microsoft.AspNetCore.HeaderPropagation.HeaderPropagationContext,Microsoft.Extensions.Primitives.StringValues> valueFilter);

override this.Add : string * string * Func<Microsoft.AspNetCore.HeaderPropagation.HeaderPropagationContext, Microsoft.Extensions.Primitives.StringValues> -> unit

Public Sub Add (inboundHeaderName As String, outboundHeaderName As String, valueFilter As Func(Of HeaderPropagationContext, StringValues))

Parameters

inboundHeaderName: String

The name of the header to be captured by HeaderPropagationMiddleware.

outboundHeaderName: String

The name of the header to be added by HeaderPropagationMessageHandler.

valueFilter: Func<HeaderPropagationContext,StringValues>

A filter delegate that can be used to transform the header value. See ValueFilter.

Applies to