Class RequestHeadersTransformExtensions

Namespace

Yarp.ReverseProxy.Transforms

Assembly

Yarp.ReverseProxy.dll

Extensions for adding request header transforms.

public static class RequestHeadersTransformExtensions

Inheritance

object

RequestHeadersTransformExtensions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

AddOriginalHost(TransformBuilderContext, bool)

Adds the transform which will copy or remove the original host header.

public static TransformBuilderContext AddOriginalHost(this TransformBuilderContext context, bool useOriginal = true)

Parameters

context TransformBuilderContext

useOriginal bool

Returns

TransformBuilderContext

AddRequestHeader(TransformBuilderContext, string, string, bool)

Adds the transform which will append or set the request header.

public static TransformBuilderContext AddRequestHeader(this TransformBuilderContext context, string headerName, string value, bool append = true)

Parameters

context TransformBuilderContext

headerName string

value string

append bool

Returns

TransformBuilderContext

AddRequestHeaderRemove(TransformBuilderContext, string)

Adds the transform which will remove the request header.

public static TransformBuilderContext AddRequestHeaderRemove(this TransformBuilderContext context, string headerName)

Parameters

context TransformBuilderContext

headerName string

Returns

TransformBuilderContext

AddRequestHeaderRouteValue(TransformBuilderContext, string, string, bool)

Adds the transform which will append or set the request header from a route value.

public static TransformBuilderContext AddRequestHeaderRouteValue(this TransformBuilderContext context, string headerName, string routeValueKey, bool append = true)

Parameters

context TransformBuilderContext

headerName string

routeValueKey string

append bool

Returns

TransformBuilderContext

AddRequestHeadersAllowed(TransformBuilderContext, params string[])

Adds the transform which will only copy the allowed request headers. Other transforms that modify or append to existing headers may be affected if not included in the allow list.

public static TransformBuilderContext AddRequestHeadersAllowed(this TransformBuilderContext context, params string[] allowedHeaders)

Parameters

context TransformBuilderContext

allowedHeaders string[]

Returns

TransformBuilderContext

WithTransformCopyRequestHeaders(RouteConfig, bool)

Clones the route and adds the transform which will enable or suppress copying request headers to the proxy request.

public static RouteConfig WithTransformCopyRequestHeaders(this RouteConfig route, bool copy = true)

Parameters

route RouteConfig

copy bool

Returns

RouteConfig

WithTransformRequestHeader(RouteConfig, string, string, bool)

Clones the route and adds the transform which will append or set the request header.

public static RouteConfig WithTransformRequestHeader(this RouteConfig route, string headerName, string value, bool append = true)

Parameters

route RouteConfig

headerName string

value string

append bool

Returns

RouteConfig

WithTransformRequestHeaderRemove(RouteConfig, string)

Clones the route and adds the transform which will remove the request header.

public static RouteConfig WithTransformRequestHeaderRemove(this RouteConfig route, string headerName)

Parameters

route RouteConfig

headerName string

Returns

RouteConfig

WithTransformRequestHeaderRouteValue(RouteConfig, string, string, bool)

Clones the route and adds the transform which will append or set the request header from a route value.

public static RouteConfig WithTransformRequestHeaderRouteValue(this RouteConfig route, string headerName, string routeValueKey, bool append = true)

Parameters

route RouteConfig

headerName string

routeValueKey string

append bool

Returns

RouteConfig

WithTransformRequestHeadersAllowed(RouteConfig, params string[])

Clones the route and adds the transform which will only copy the allowed request headers. Other transforms that modify or append to existing headers may be affected if not included in the allow list.

public static RouteConfig WithTransformRequestHeadersAllowed(this RouteConfig route, params string[] allowedHeaders)

Parameters

route RouteConfig

allowedHeaders string[]

Returns

RouteConfig

WithTransformUseOriginalHostHeader(RouteConfig, bool)

Clones the route and adds the transform which will copy the incoming request Host header to the proxy request.

public static RouteConfig WithTransformUseOriginalHostHeader(this RouteConfig route, bool useOriginal = true)

Parameters

route RouteConfig

useOriginal bool

Returns

RouteConfig