withGatewayPathRoute

1. Docs
2. /Reference
3. /Search TypeScript APIs
4. /Aspire.Hosting.Kubernetes
5. /withGatewayPathRoute

Method

📦 Aspire.Hosting.Kubernetes v13.6.0-preview.1.26478.8

interface KubernetesGatewayResource {
  // ... omitted for brevity
  withGatewayPathRoute(
      path: string,
      endpoint: EndpointReference,
      pathType?: GatewayPathMatchType): KubernetesGatewayResource;
}

Signature

methodwithGatewayPathRoutebuilder

Adds a path-based routing rule to the gateway. The rule matches each hostname configured with `WithHostname`, or all hosts when no hostname is configured, and routes matching traffic to the endpoint's backing Kubernetes service. This generates an `HTTPRoute` resource attached to the Gateway.

withGatewayPathRoute(
    path: string,
    endpoint: EndpointReference,
    pathType?: GatewayPathMatchType): KubernetesGatewayResource

Parameters

pathstring

endpointEndpointReference

pathTypeGatewayPathMatchTypeoptional= PathPrefix

Returns

KubernetesGatewayResource

Applies to

This method applies to the following types:

typeKubernetesGatewayResource