Class DirectForwardingIEndpointRouteBuilderExtensions

Namespace

Microsoft.AspNetCore.Builder

Assembly

Yarp.ReverseProxy.dll

Extension methods for IEndpointRouteBuilder used to add direct forwarding to the ASP.NET Core request pipeline.

public static class DirectForwardingIEndpointRouteBuilderExtensions

Inheritance

object

DirectForwardingIEndpointRouteBuilderExtensions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

MapForwarder(IEndpointRouteBuilder, string, string)

Adds direct forwarding of HTTP requests that match the specified pattern to a specific destination using default configuration for the outgoing request, default transforms, and default HTTP client.

public static IEndpointConventionBuilder MapForwarder(this IEndpointRouteBuilder endpoints, string pattern, string destinationPrefix)

Parameters

endpoints IEndpointRouteBuilder

pattern string

destinationPrefix string

Returns

IEndpointConventionBuilder

MapForwarder(IEndpointRouteBuilder, string, string, Action<TransformBuilderContext>)

Adds direct forwarding of HTTP requests that match the specified pattern to a specific destination using default configuration for the outgoing request, customized transforms, and default HTTP client.

public static IEndpointConventionBuilder MapForwarder(this IEndpointRouteBuilder endpoints, string pattern, string destinationPrefix, Action<TransformBuilderContext> configureTransform)

Parameters

endpoints IEndpointRouteBuilder

pattern string

destinationPrefix string

configureTransform Action<TransformBuilderContext>

Returns

IEndpointConventionBuilder

MapForwarder(IEndpointRouteBuilder, string, string, string)

Adds direct forwarding of HTTP requests that match the specified pattern to a specific destination and target path applying route values from the pattern using default configuration for the outgoing request, and default HTTP client.

public static IEndpointConventionBuilder MapForwarder(this IEndpointRouteBuilder endpoints, string pattern, string destinationPrefix, string targetPath)

Parameters

endpoints IEndpointRouteBuilder

pattern string

destinationPrefix string

targetPath string

Returns

IEndpointConventionBuilder

MapForwarder(IEndpointRouteBuilder, string, string, ForwarderRequestConfig)

Adds direct forwarding of HTTP requests that match the specified pattern to a specific destination using customized configuration for the outgoing request, default transforms, and default HTTP client.

public static IEndpointConventionBuilder MapForwarder(this IEndpointRouteBuilder endpoints, string pattern, string destinationPrefix, ForwarderRequestConfig requestConfig)

Parameters

endpoints IEndpointRouteBuilder

pattern string

destinationPrefix string

requestConfig ForwarderRequestConfig

Returns

IEndpointConventionBuilder

MapForwarder(IEndpointRouteBuilder, string, string, ForwarderRequestConfig, Action<TransformBuilderContext>)

Adds direct forwarding of HTTP requests that match the specified pattern to a specific destination using customized configuration for the outgoing request, customized transforms, and default HTTP client.

public static IEndpointConventionBuilder MapForwarder(this IEndpointRouteBuilder endpoints, string pattern, string destinationPrefix, ForwarderRequestConfig requestConfig, Action<TransformBuilderContext> configureTransform)

Parameters

endpoints IEndpointRouteBuilder

pattern string

destinationPrefix string

requestConfig ForwarderRequestConfig

configureTransform Action<TransformBuilderContext>

Returns

IEndpointConventionBuilder

MapForwarder(IEndpointRouteBuilder, string, string, ForwarderRequestConfig, string)

Adds direct forwarding of HTTP requests that match the specified pattern to a specific destination and target path applying route values from the pattern using customized configuration for the outgoing request, and default HTTP client.

public static IEndpointConventionBuilder MapForwarder(this IEndpointRouteBuilder endpoints, string pattern, string destinationPrefix, ForwarderRequestConfig requestConfig, string targetPath)

Parameters

endpoints IEndpointRouteBuilder

pattern string

destinationPrefix string

requestConfig ForwarderRequestConfig

targetPath string

Returns

IEndpointConventionBuilder

MapForwarder(IEndpointRouteBuilder, string, string, ForwarderRequestConfig, HttpTransformer)

Adds direct forwarding of HTTP requests that match the specified pattern to a specific destination using customized configuration for the outgoing request, customized transforms, and default HTTP client.

public static IEndpointConventionBuilder MapForwarder(this IEndpointRouteBuilder endpoints, string pattern, string destinationPrefix, ForwarderRequestConfig requestConfig, HttpTransformer transformer)

Parameters

endpoints IEndpointRouteBuilder

pattern string

destinationPrefix string

requestConfig ForwarderRequestConfig

transformer HttpTransformer

Returns

IEndpointConventionBuilder

MapForwarder(IEndpointRouteBuilder, string, string, ForwarderRequestConfig, HttpTransformer, HttpMessageInvoker)

Adds direct forwarding of HTTP requests that match the specified pattern to a specific destination using customized configuration for the outgoing request, customized transforms, and customized HTTP client.

public static IEndpointConventionBuilder MapForwarder(this IEndpointRouteBuilder endpoints, string pattern, string destinationPrefix, ForwarderRequestConfig requestConfig, HttpTransformer transformer, HttpMessageInvoker httpClient)

Parameters

endpoints IEndpointRouteBuilder

pattern string

destinationPrefix string

requestConfig ForwarderRequestConfig

transformer HttpTransformer

httpClient HttpMessageInvoker

Returns

IEndpointConventionBuilder