IYarpConfigurationBuilder

Interface

📦 Aspire.Hosting.Yarp v13.6.0

interface IYarpConfigurationBuilder {
  addCatchAllRoute(target: YarpCluster | EndpointReference | IResourceWithServiceDiscovery | 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: YarpCluster | EndpointReference | IResourceWithServiceDiscovery | ExternalServiceResource | string): YarpRoute;
}

7 members

Methods

methodaddCatchAllRoute

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

addCatchAllRoute(target: YarpCluster | EndpointReference | IResourceWithServiceDiscovery | ExternalServiceResource | string): YarpRoute

Parameters

targetYarpCluster | EndpointReference | IResourceWithServiceDiscovery | ExternalServiceResource | string

Returns

YarpRoute

methodaddClusterFromEndpoint

Adds a cluster for an endpoint reference.

addClusterFromEndpoint(endpoint: EndpointReference): YarpCluster

Parameters

endpointEndpointReference

Returns

YarpCluster

methodaddClusterFromExternalService

Adds a cluster for an external service resource.

addClusterFromExternalService(externalService: ExternalServiceResource): YarpCluster

Parameters

externalServiceExternalServiceResource

Returns

YarpCluster

methodaddClusterFromResource

Adds a cluster for a resource that supports service discovery.

addClusterFromResource(resource: IResourceWithServiceDiscovery): YarpCluster

Parameters

resourceIResourceWithServiceDiscovery

Returns

YarpCluster

methodaddClusterWithDestination

Adds a cluster from a single destination.

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

Parameters

clusterNamestring

destinationany

Returns

YarpCluster

methodaddClusterWithDestinations

Adds a cluster from multiple destinations.

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

Parameters

clusterNamestring

destinationsany[]

Returns

YarpCluster

methodaddRoute

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

addRoute(
    path: string,
    target: YarpCluster | EndpointReference | IResourceWithServiceDiscovery | ExternalServiceResource | string): YarpRoute

Parameters

pathstring

targetYarpCluster | EndpointReference | IResourceWithServiceDiscovery | ExternalServiceResource | string

Returns

YarpRoute