YarpCluster

Docs / Reference / Search TypeScript APIs / Aspire.Hosting.Yarp / YarpCluster

YarpCluster

Docs Reference Search TypeScript APIs Aspire.Hosting.Yarp YarpCluster

Handle

📦 Aspire.Hosting.Yarp v13.2.0

interface YarpCluster {
  withForwarderRequestConfig(config: YarpForwarderRequestConfig): YarpCluster;
  withHealthCheckConfig(config: YarpHealthCheckConfig): YarpCluster;
  withHttpClientConfig(config: YarpHttpClientConfig): YarpCluster;
  withLoadBalancingPolicy(policy: string): YarpCluster;
  withMetadata(metadata: Dict<string,string>): YarpCluster;
  withSessionAffinityConfig(config: YarpSessionAffinityConfig): YarpCluster;
}

Search members of YarpCluster…

6 members Clear filters

Methods

method withForwarderRequestConfig

Sets the forwarder request configuration for the cluster.

withForwarderRequestConfig(config: YarpForwarderRequestConfig): YarpCluster

Parameters

config YarpForwarderRequestConfig

Returns

YarpCluster

method withHealthCheckConfig

Sets the health check configuration for the cluster.

withHealthCheckConfig(config: YarpHealthCheckConfig): YarpCluster

Parameters

config YarpHealthCheckConfig

Returns

YarpCluster

method withHttpClientConfig

Sets the HTTP client configuration for the cluster.

withHttpClientConfig(config: YarpHttpClientConfig): YarpCluster

Parameters

config YarpHttpClientConfig

Returns

YarpCluster

method withLoadBalancingPolicy

Sets the load balancing policy for the cluster.

withLoadBalancingPolicy(policy: string): YarpCluster

Parameters

policy string

Returns

YarpCluster

method withMetadata

Sets metadata for the cluster.

withMetadata(metadata: Dict<string,string>): YarpCluster

Parameters

metadata Dict<string,string>

Returns

YarpCluster

method withSessionAffinityConfig

Sets the session affinity configuration for the cluster.

withSessionAffinityConfig(config: YarpSessionAffinityConfig): YarpCluster

Parameters

config YarpSessionAffinityConfig

Returns

YarpCluster