Skip to content
DocsTry Aspire
DocsTry

RequestHeadersTransformExtensions Methods

ClassMethods6 members
Extensions for adding request header transforms.
WithTransformCopyRequestHeaders(YarpRoute, bool)Section titled 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)
{
// ...
}
}
copybooloptional
WithTransformRequestHeader(YarpRoute, string, string, bool)Section titled 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)
{
// ...
}
}
headerNamestring
valuestring
appendbooloptional
WithTransformRequestHeaderRemove(YarpRoute, string)Section titled 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)
{
// ...
}
}
headerNamestring
WithTransformRequestHeaderRouteValue(YarpRoute, string, string, bool)Section titled 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)
{
// ...
}
}
headerNamestring
routeValueKeystring
appendbooloptional
WithTransformRequestHeadersAllowed(YarpRoute, string[])Section titled 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)
{
// ...
}
}
allowedHeadersstring[]
WithTransformUseOriginalHostHeader(YarpRoute, bool)Section titled 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)
{
// ...
}
}
useOriginalbooloptional