IYarpConfigurationBuilder Methods
Interface Methods 6 members
Interface to build a configuration file for YARP
Add a new cluster to YARP.
public interface IYarpConfigurationBuilder{ public abstract YarpCluster AddCluster( EndpointReference endpoint) { // ... }}Parameters
endpoint EndpointReference The endpoint target for this cluster. Remarks
This overload is not available in polyglot app hosts. Use the
addClusterFromEndpoint helper instead.AddCluster(IResourceBuilder<IResourceWithServiceDiscovery>) Section titled AddCluster(IResourceBuilder<IResourceWithServiceDiscovery>) abstract YarpCluster Add a new cluster to YARP based on a resource that supports service discovery.
public interface IYarpConfigurationBuilder{ public abstract YarpCluster AddCluster( IResourceBuilder<IResourceWithServiceDiscovery> resource) { // ... }}Parameters
resource IResourceBuilder<IResourceWithServiceDiscovery> The resource target for this cluster. Remarks
This overload is not available in polyglot app hosts. Use the
addClusterFromResource helper instead.AddCluster(IResourceBuilder<ExternalServiceResource>) Section titled AddCluster(IResourceBuilder<ExternalServiceResource>) abstract YarpCluster Add a new cluster to YARP based on an external service resource.
public interface IYarpConfigurationBuilder{ public abstract YarpCluster AddCluster( IResourceBuilder<ExternalServiceResource> externalService) { // ... }}Parameters
externalService IResourceBuilder<ExternalServiceResource> The external service used by this cluster. Remarks
This overload is not available in polyglot app hosts. Use the
addClusterFromExternalService helper instead. Add a new cluster to YARP based on a collection of urls.
public interface IYarpConfigurationBuilder{ public abstract YarpCluster AddCluster( string clusterName, object[] destinations) { // ... }}Parameters
clusterName string The name of the cluster. destinations object[] The destinations used by this cluster. Remarks
This overload is not available in polyglot app hosts. Use the
addClusterWithDestinations helper instead. Add a new cluster to YARP based on a collection of urls.
public interface IYarpConfigurationBuilder{ public virtual YarpCluster AddCluster( string clusterName, object destination) { // ... }}Parameters
clusterName string The name of the cluster. destination object The destinations used by this cluster. Remarks
This overload is not available in polyglot app hosts. Use the
addClusterWithDestination helper instead. Add a new route to YARP that will target the cluster in parameter.
public interface IYarpConfigurationBuilder{ public abstract YarpRoute AddRoute( string path, YarpCluster cluster) { // ... }}Parameters
path string The path to match for this route. cluster YarpCluster The target cluster for this route.