Skip to content
Docs Try Aspire
Docs Try

Aspire.Hosting.Azure.Kubernetes

Official
📦 Aspire.Hosting.Azure.Kubernetes v13.4.0-preview.1.26281.18
14 Functions
3 Types

Types

Functions

method addAzureKubernetesEnvironment builder
Adds an Azure Kubernetes Service (AKS) environment to the distributed application. This provisions an AKS cluster and configures it as a Kubernetes compute environment.
addAzureKubernetesEnvironment(name: string): AzureKubernetesEnvironmentResource
method addCertManager builder
Installs cert-manager into an AKS environment
addCertManager(name: string, chartVersion?: string): CertManagerResource
method addGateway builder
Adds a Kubernetes Gateway API Gateway resource to the application model, associated with the inner Kubernetes environment of the specified AKS environment.
addGateway(name: string): KubernetesGatewayResource
method addHelmChart builder
Adds an external Helm chart to be installed in the AKS environment's inner Kubernetes environment. The chart is installed via `helm upgrade --install` as a pipeline step after the main application Helm chart is deployed.
addHelmChart(name: string, chartReference: string, chartVersion: string): KubernetesHelmChartResource
method addIngress builder
Adds a Kubernetes Ingress resource to the application model, associated with the inner Kubernetes environment of the specified AKS environment. The ingress generates a `networking.k8s.io/v1 Ingress` resource in the Helm chart output at publish time.
addIngress(name: string): KubernetesIngressResource
method addLoadBalancer builder
Adds an Azure Application Gateway for Containers (AGC) `ApplicationLoadBalancer` to this AKS environment, bound to the supplied delegated subnet. Returns a resource builder that can be passed to `gateway.WithLoadBalancer(lb)` / `ingress.WithLoadBalancer(lb)` to route traffic through this load balancer.
addLoadBalancer(name: string, subnet: AzureSubnetResource): AzureKubernetesLoadBalancerResource
method addNodePool builder
Adds a node pool to the AKS cluster.
addNodePool(name: string, vmSize?: string, minCount?: number, maxCount?: number): AksNodePoolResource
method withContainerRegistry builder
Configures the AKS environment to use a specific Azure Container Registry for image storage. When set, this replaces the auto-created default container registry.
withContainerRegistry(registry: AzureContainerRegistryResource): AzureKubernetesEnvironmentResource
method withLoadBalancer builder
Routes a Kubernetes Gateway through an AGC ApplicationLoadBalancer
withLoadBalancer(loadBalancer: AzureKubernetesLoadBalancerResource): KubernetesGatewayResource
method withLoadBalancer builder
Routes a Kubernetes Ingress through an AGC ApplicationLoadBalancer
withLoadBalancer(loadBalancer: AzureKubernetesLoadBalancerResource): KubernetesIngressResource
method withSubnet builder
Configures the AKS cluster to use a VNet subnet
withSubnet(subnet: AzureSubnetResource): AzureKubernetesEnvironmentResource
method withSubnet builder
Configures an AKS node pool to use a specific VNet subnet
withSubnet(subnet: AzureSubnetResource): AksNodePoolResource
method withSystemNodePool builder
Replaces the default system node pool with a customized configuration.
withSystemNodePool(vmSize?: string, minCount?: number, maxCount?: number): AzureKubernetesEnvironmentResource
method withWorkloadIdentity builder
Enables or disables workload identity on the AKS environment, allowing pods to authenticate to Azure services using federated credentials.
withWorkloadIdentity(enabled?: boolean): AzureKubernetesEnvironmentResource