Aspire.Hosting.Kubernetes
Official
📦 Aspire.Hosting.Kubernetes v13.3.0-preview.1.26254.5 36 Functions
8 Types
8 types and 28 members
Types
Functions
method
addGateway builder Adds a Kubernetes Gateway API Gateway resource
addGateway(name: string): KubernetesGatewayResource method
addIngress builder Adds a Kubernetes Ingress resource for HTTP routing
addIngress(name: string): KubernetesIngressResource method
addKubernetesEnvironment builder Adds a Kubernetes publishing environment
addKubernetesEnvironment(name: string): KubernetesEnvironmentResource method
addNodePool builder Adds a named node pool to a Kubernetes environment
addNodePool(name: string): KubernetesNodePoolResource method
configureDashboard builder Configures the Aspire dashboard resource for the Kubernetes environment
configureDashboard(configure: (obj: KubernetesAspireDashboardResource) => Promise<void>): KubernetesEnvironmentResource method
publishAsKubernetesService builder Publishes the resource as a Kubernetes service
publishAsKubernetesService(configure: (obj: KubernetesResource) => Promise<void>): IComputeResource method
withDashboard builder Enables or disables the Aspire dashboard for the Kubernetes environment
withDashboard(enabled?: boolean): KubernetesEnvironmentResource method
withDefaultBackend builder Sets the default backend for a Kubernetes Ingress
withDefaultBackend(endpoint: EndpointReference): KubernetesIngressResource method
withForwardedHeaders builder Enables or disables forwarded headers support for the Aspire dashboard
withForwardedHeaders(enabled?: boolean): KubernetesAspireDashboardResource method
withGatewayAnnotation builder Adds a Kubernetes metadata annotation to a Gateway
withGatewayAnnotation(key: string, value: string): KubernetesGatewayResource method
withGatewayAnnotationParam builder Adds a parameterized Kubernetes metadata annotation to a Gateway
withGatewayAnnotationParam(key: string, value: ParameterResource): KubernetesGatewayResource method
withGatewayClass builder Sets the GatewayClass for a Kubernetes Gateway
withGatewayClass(className: string): KubernetesGatewayResource method
withGatewayClassParam builder Sets a parameterized GatewayClass for a Kubernetes Gateway
withGatewayClassParam(className: ParameterResource): KubernetesGatewayResource method
withGatewayHostnameParam builder Adds a parameterized hostname to a Kubernetes Gateway
withGatewayHostnameParam(hostname: ParameterResource): KubernetesGatewayResource method
withGatewayHostRoute builder Adds a host-and-path route to a Kubernetes Gateway
withGatewayHostRoute(host: string, path: string, endpoint: EndpointReference, pathType?: IngressPathType): KubernetesGatewayResource method
withGatewayPathRoute builder Adds a path-based route to a Kubernetes Gateway
withGatewayPathRoute(path: string, endpoint: EndpointReference, pathType?: IngressPathType): KubernetesGatewayResource method
withGatewayTlsAuto builder Configures TLS on a Kubernetes Gateway with an auto-generated secret
withGatewayTlsAuto(): KubernetesGatewayResource method
withGatewayTlsParam builder Configures TLS on a Kubernetes Gateway with a parameterized secret
withGatewayTlsParam(secretName: ParameterResource): KubernetesGatewayResource method
withHelm builder Configures Helm chart deployment settings
withHelm(configure?: (obj: HelmChartOptions) => Promise<void>): KubernetesEnvironmentResource method
withHostname builder Adds a hostname to a Kubernetes Gateway
withHostname(hostname: string): KubernetesGatewayResource method
withHostname builder Adds a hostname to a Kubernetes Ingress
withHostname(hostname: string): KubernetesIngressResource method
withIngressAnnotation builder Adds a Kubernetes metadata annotation to a Kubernetes Ingress
withIngressAnnotation(key: string, value: string): KubernetesIngressResource method
withIngressAnnotationParam builder Adds a parameterized Kubernetes metadata annotation to an Ingress
withIngressAnnotationParam(key: string, value: ParameterResource): KubernetesIngressResource method
withIngressClass builder Sets the ingress class for a Kubernetes Ingress
withIngressClass(className: string): KubernetesIngressResource method
withIngressClassParam builder Sets a parameterized ingress class for a Kubernetes Ingress
withIngressClassParam(className: ParameterResource): KubernetesIngressResource method
withIngressHostnameParam builder Adds a parameterized hostname to a Kubernetes Ingress
withIngressHostnameParam(hostname: ParameterResource): KubernetesIngressResource method
withIngressHostRoute builder Adds a host-and-path route to a Kubernetes Ingress
withIngressHostRoute(host: string, path: string, endpoint: EndpointReference, pathType?: IngressPathType): KubernetesIngressResource method
withIngressPathRoute builder Adds a path-based route to a Kubernetes Ingress
withIngressPathRoute(path: string, endpoint: EndpointReference, pathType?: IngressPathType): KubernetesIngressResource method
withIngressTlsAuto builder Configures TLS for a Kubernetes Ingress with an auto-generated secret
withIngressTlsAuto(): KubernetesIngressResource method
withIngressTlsParam builder Configures TLS for a Kubernetes Ingress with a parameterized secret
withIngressTlsParam(secretName: ParameterResource): KubernetesIngressResource method
withNodePool builder Schedules a workload on a specific Kubernetes node pool
withNodePool(nodePool: KubernetesNodePoolResource): IResource method
withOtlpServicePort builder Sets the Kubernetes Service ports for the OTLP endpoints
withOtlpServicePort(grpcPort?: number, httpPort?: number): KubernetesAspireDashboardResource method
withProperties builder Configures properties of a Kubernetes environment
withProperties(configure: (obj: KubernetesEnvironmentResource) => Promise<void>): KubernetesEnvironmentResource method
withServicePort builder Sets the Kubernetes Service port for the Aspire dashboard
withServicePort(port?: number): KubernetesAspireDashboardResource method
withTls builder Configures TLS on a Kubernetes Gateway listener
withTls(secretName: string): KubernetesGatewayResource method
withTls builder Configures TLS for a Kubernetes Ingress using a K8S secret
withTls(secretName: string): KubernetesIngressResource