Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

YarpConfigurationBuilder

Interface
📦 Aspire.Hosting.Yarp v17.0.0

Interface to build a configuration file for YARP

type YarpConfigurationBuilder interface{}

Methods

Adds a catch-all route for a cluster, endpoint, resource, or string destination target.
AddCatchAllRoute(target any) YarpRoute
targetanyThe target cluster, endpoint, resource, or string destination for this route.
YarpRoute

The created route.

Returns a handle; failures surface later via Err().

Adds a cluster for an endpoint reference.
AddClusterFromEndpoint(endpoint EndpointReference) YarpCluster
endpointEndpointReferenceThe endpoint target for this cluster.
YarpCluster

The created cluster.

Returns a handle; failures surface later via Err().

Adds a cluster for an external service resource.
AddClusterFromExternalService(externalService ExternalServiceResource) YarpCluster
externalServiceExternalServiceResourceThe external service used by this cluster.
YarpCluster

The created cluster.

Returns a handle; failures surface later via Err().

Adds a cluster for a resource that supports service discovery.
AddClusterFromResource(resource ResourceWithServiceDiscovery) YarpCluster
resourceResourceWithServiceDiscoveryThe resource target for this cluster.
YarpCluster

The created cluster.

Returns a handle; failures surface later via Err().

Adds a cluster from a single destination.
AddClusterWithDestination(
clusterName string,
destination any,
) YarpCluster
clusterNamestringThe name of the cluster.
destinationanyThe destination used by this cluster.
YarpCluster

The created cluster.

Returns a handle; failures surface later via Err().

Adds a cluster from multiple destinations.
AddClusterWithDestinations(
clusterName string,
destinations []any,
) YarpCluster
clusterNamestringThe name of the cluster.
destinations[]anyThe destinations used by this cluster.
YarpCluster

The created cluster.

Returns a handle; failures surface later via Err().

methodAddRoute
Adds a route for a cluster, endpoint, resource, or string destination target.
AddRoute(
path string,
target any,
) YarpRoute
pathstringThe path to match for this route.
targetanyThe target cluster, endpoint, resource, or string destination for this route.
YarpRoute

The created route.

Returns a handle; failures surface later via Err().

Applies to

This interface applies to the following types: