IYarpConfigurationBuilder

Interface

📦 Aspire.Hosting.Yarp v13.3.0

interface IYarpConfigurationBuilder {
  addCatchAllRoute(target: ExternalServiceResource|string): YarpRoute;
  addClusterFromEndpoint(endpoint: EndpointReference): YarpCluster;
  addClusterFromExternalService(externalService: ExternalServiceResource): YarpCluster;
  addClusterFromResource(resource: IResourceWithServiceDiscovery): YarpCluster;
  addClusterWithDestination(
      clusterName: string,
      destination: any): YarpCluster;
  addClusterWithDestinations(
      clusterName: string,
      destinations: any[]): YarpCluster;
  addRoute(
      path: string,
      target: ExternalServiceResource|string): YarpRoute;
}

7 members

Methods

method addCatchAllRoute

Adds a YARP catch-all route for a cluster, endpoint, resource, or string destination target.

addCatchAllRoute(target: ExternalServiceResource|string): YarpRoute

Parameters

target ExternalServiceResource|string

Returns

YarpRoute

method addClusterFromEndpoint

Adds a YARP cluster for an endpoint reference.

addClusterFromEndpoint(endpoint: EndpointReference): YarpCluster

Parameters

endpoint EndpointReference

Returns

YarpCluster

method addClusterFromExternalService

Adds a YARP cluster for an external service resource.

addClusterFromExternalService(externalService: ExternalServiceResource): YarpCluster

Parameters

externalService ExternalServiceResource

Returns

YarpCluster

method addClusterFromResource

Adds a YARP cluster for a resource that supports service discovery.

addClusterFromResource(resource: IResourceWithServiceDiscovery): YarpCluster

Parameters

resource IResourceWithServiceDiscovery

Returns

YarpCluster

method addClusterWithDestination

Adds a YARP cluster with a single destination.

addClusterWithDestination(
    clusterName: string,
    destination: any): YarpCluster

Parameters

clusterName string

destination any

Returns

YarpCluster

method addClusterWithDestinations

Adds a YARP cluster with multiple destinations.

addClusterWithDestinations(
    clusterName: string,
    destinations: any[]): YarpCluster

Parameters

clusterName string

destinations any[]

Returns

YarpCluster

method addRoute

Adds a YARP route for a cluster, endpoint, resource, or string destination target.

addRoute(
    path: string,
    target: ExternalServiceResource|string): YarpRoute

Parameters

path string

target ExternalServiceResource|string

Returns

YarpRoute