Class ReverseProxyServiceCollectionExtensions

Extensions for used to register the ReverseProxy's components.

Inheritance
System.Object
ReverseProxyServiceCollectionExtensions
Namespace: Microsoft.Extensions.DependencyInjection
Assembly: Yarp.ReverseProxy.dll
Syntax
public static class ReverseProxyServiceCollectionExtensions : object

Methods

| Improve this Doc View Source

AddConfigFilter<TService>(IReverseProxyBuilder)

Registers a singleton IProxyConfigFilter service. Multiple filters are allowed, and they will be run in registration order.

Declaration
public static IReverseProxyBuilder AddConfigFilter<TService>(this IReverseProxyBuilder builder)
    where TService : class, IProxyConfigFilter
Parameters
Type Name Description
IReverseProxyBuilder builder
Returns
Type Description
IReverseProxyBuilder
Type Parameters
Name Description
TService

A class that implements IProxyConfigFilter.
| Improve this Doc View Source

AddDnsDestinationResolver(IReverseProxyBuilder, Nullable<Action<DnsDestinationResolverOptions>>)

Provides a IDestinationResolver implementation which uses to resolve destinations.

Declaration
public static IReverseProxyBuilder AddDnsDestinationResolver(this IReverseProxyBuilder builder, Action<DnsDestinationResolverOptions>? configureOptions = null)
Parameters
Type Name Description
IReverseProxyBuilder builder
System.Nullable<Action<DnsDestinationResolverOptions>> configureOptions
Returns
Type Description
IReverseProxyBuilder
| Improve this Doc View Source

AddHttpForwarder(IServiceCollection)

Registers the IHttpForwarder service for direct forwarding scenarios.

Declaration
public static IServiceCollection AddHttpForwarder(this IServiceCollection services)
Parameters
Type Name Description
IServiceCollection services
Returns
Type Description
IServiceCollection
| Improve this Doc View Source

AddReverseProxy(IServiceCollection)

Adds ReverseProxy's services to Dependency Injection.

Declaration
public static IReverseProxyBuilder AddReverseProxy(this IServiceCollection services)
Parameters
Type Name Description
IServiceCollection services
Returns
Type Description
IReverseProxyBuilder
| Improve this Doc View Source

AddTransformFactory<T>(IReverseProxyBuilder)

Adds a ITransformFactory implementation that will be used to read route transform config and generate the associated transform actions. AddTransformFactory<T>(IReverseProxyBuilder) can be called multiple times to provide multiple distinct types.

Declaration
public static IReverseProxyBuilder AddTransformFactory<T>(this IReverseProxyBuilder builder)
    where T : class, ITransformFactory
Parameters
Type Name Description
IReverseProxyBuilder builder
Returns
Type Description
IReverseProxyBuilder
Type Parameters
Name Description
T
| Improve this Doc View Source

AddTransforms(IReverseProxyBuilder, Action<TransformBuilderContext>)

Provides a callback that will be run for each route to conditionally add transforms. AddTransforms(IReverseProxyBuilder, Action<TransformBuilderContext>) can be called multiple times to provide multiple callbacks.

Declaration
public static IReverseProxyBuilder AddTransforms(this IReverseProxyBuilder builder, Action<TransformBuilderContext> action)
Parameters
Type Name Description
IReverseProxyBuilder builder
Action<TransformBuilderContext> action
Returns
Type Description
IReverseProxyBuilder
| Improve this Doc View Source

AddTransforms<T>(IReverseProxyBuilder)

Provides a ITransformProvider implementation that will be run for each route to conditionally add transforms. AddTransforms<T>(IReverseProxyBuilder) can be called multiple times to provide multiple distinct types.

Declaration
public static IReverseProxyBuilder AddTransforms<T>(this IReverseProxyBuilder builder)
    where T : class, ITransformProvider
Parameters
Type Name Description
IReverseProxyBuilder builder
Returns
Type Description
IReverseProxyBuilder
Type Parameters
Name Description
T
| Improve this Doc View Source

ConfigureHttpClient(IReverseProxyBuilder, Action<ForwarderHttpClientContext, SocketsHttpHandler>)

Provides a callback to customize settings used for proxying requests. This will be called each time a cluster is added or changed. Cluster settings are applied to the handler before the callback. Custom data can be provided in the cluster metadata.

Declaration
public static IReverseProxyBuilder ConfigureHttpClient(this IReverseProxyBuilder builder, Action<ForwarderHttpClientContext, SocketsHttpHandler> configure)
Parameters
Type Name Description
IReverseProxyBuilder builder
Action<ForwarderHttpClientContext, SocketsHttpHandler> configure
Returns
Type Description
IReverseProxyBuilder
| Improve this Doc View Source

LoadFromConfig(IReverseProxyBuilder, IConfiguration)

Loads routes and endpoints from config.

Declaration
public static IReverseProxyBuilder LoadFromConfig(this IReverseProxyBuilder builder, IConfiguration config)
Parameters
Type Name Description
IReverseProxyBuilder builder
IConfiguration config
Returns
Type Description
IReverseProxyBuilder