Skip to content
Docs Try Aspire

RequestHeadersTransformExtensions Methods

Class Methods 6 members
Extensions for adding request header transforms.
WithTransformCopyRequestHeaders(YarpRoute, bool) Section titled WithTransformCopyRequestHeaders(YarpRoute, bool) extension YarpRoute
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)
{
// ...
}
}
route YarpRoute
copy bool optional
WithTransformRequestHeader(YarpRoute, string, string, bool) Section titled WithTransformRequestHeader(YarpRoute, string, string, bool) extension YarpRoute
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)
{
// ...
}
}
route YarpRoute
headerName string
value string
append bool optional
WithTransformRequestHeaderRemove(YarpRoute, string) Section titled WithTransformRequestHeaderRemove(YarpRoute, string) extension YarpRoute
Adds the transform which will remove the request header.
public static class RequestHeadersTransformExtensions
{
public static YarpRoute WithTransformRequestHeaderRemove(
this YarpRoute route,
string headerName)
{
// ...
}
}
route YarpRoute
headerName string
WithTransformRequestHeaderRouteValue(YarpRoute, string, string, bool) Section titled WithTransformRequestHeaderRouteValue(YarpRoute, string, string, bool) extension YarpRoute
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)
{
// ...
}
}
route YarpRoute
headerName string
routeValueKey string
append bool optional
WithTransformRequestHeadersAllowed(YarpRoute, string[]) Section titled WithTransformRequestHeadersAllowed(YarpRoute, string[]) extension YarpRoute
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)
{
// ...
}
}
route YarpRoute
allowedHeaders string[]
WithTransformUseOriginalHostHeader(YarpRoute, bool) Section titled WithTransformUseOriginalHostHeader(YarpRoute, bool) extension YarpRoute
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)
{
// ...
}
}
route YarpRoute
useOriginal bool optional