Interface IProxyConfigFilter

Namespace

Yarp.ReverseProxy.Configuration

Assembly

Yarp.ReverseProxy.dll

A configuration filter that will run each time the proxy configuration is loaded.

public interface IProxyConfigFilter

Methods

ConfigureClusterAsync(ClusterConfig, CancellationToken)

Allows modification of a cluster configuration.

ValueTask<ClusterConfig> ConfigureClusterAsync(ClusterConfig cluster, CancellationToken cancel)

Parameters

cluster ClusterConfig

The ClusterConfig instance to configure.

cancel CancellationToken

Returns

ValueTask<ClusterConfig>

ConfigureRouteAsync(RouteConfig, ClusterConfig?, CancellationToken)

Allows modification of a route configuration.

ValueTask<RouteConfig> ConfigureRouteAsync(RouteConfig route, ClusterConfig? cluster, CancellationToken cancel)

Parameters

route RouteConfig

The RouteConfig instance to configure.

cluster ClusterConfig

The ClusterConfig instance related to RouteConfig.

cancel CancellationToken

Returns

ValueTask<RouteConfig>