RequestHeadersTransformExtensions Methods

WithTransformCopyRequestHeaders(YarpRoute, bool)extensionYarpRoute

Adds the transform which will enable or suppress copying request headers to the proxy request.

public static class RequestHeadersTransformExtensions
{
    public static YarpRoute WithTransformCopyRequestHeaders(
        this YarpRoute route,
        bool copy = true)
    {
        // ...
    }
}

RequestHeadersTransformExtensions.cs#L19-L20

Parameters

routeYarpRoute

copybooloptional

WithTransformRequestHeader(YarpRoute, string, string, bool)extensionYarpRoute

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

public static class RequestHeadersTransformExtensions
{
    public static YarpRoute WithTransformRequestHeader(
        this YarpRoute route,
        string headerName,
        string value,
        bool append = true)
    {
        // ...
    }
}

RequestHeadersTransformExtensions.cs#L39-L40

Parameters

routeYarpRoute

headerNamestring

valuestring

appendbooloptional

WithTransformRequestHeaderRemove(YarpRoute, string)extensionYarpRoute

Adds the transform which will remove the request header.

public static class RequestHeadersTransformExtensions
{
    public static YarpRoute WithTransformRequestHeaderRemove(
        this YarpRoute route,
        string headerName)
    {
        // ...
    }
}

RequestHeadersTransformExtensions.cs#L59-L60

Parameters

routeYarpRoute

headerNamestring

WithTransformRequestHeaderRouteValue(YarpRoute, string, string, bool)extensionYarpRoute

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

public static class RequestHeadersTransformExtensions
{
    public static YarpRoute WithTransformRequestHeaderRouteValue(
        this YarpRoute route,
        string headerName,
        string routeValueKey,
        bool append = true)
    {
        // ...
    }
}

RequestHeadersTransformExtensions.cs#L49-L50

Parameters

routeYarpRoute

headerNamestring

routeValueKeystring

appendbooloptional

WithTransformRequestHeadersAllowed(YarpRoute, string[])extensionYarpRoute

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 class RequestHeadersTransformExtensions
{
    public static YarpRoute WithTransformRequestHeadersAllowed(
        this YarpRoute route,
        params string[] allowedHeaders)
    {
        // ...
    }
}

RequestHeadersTransformExtensions.cs#L70-L71

Parameters

routeYarpRoute

allowedHeadersstring[]

WithTransformUseOriginalHostHeader(YarpRoute, bool)extensionYarpRoute

Adds the transform which will copy the incoming request Host header to the proxy request.

public static class RequestHeadersTransformExtensions
{
    public static YarpRoute WithTransformUseOriginalHostHeader(
        this YarpRoute route,
        bool useOriginal = true)
    {
        // ...
    }
}

RequestHeadersTransformExtensions.cs#L29-L30

Parameters

routeYarpRoute

useOriginalbooloptional