AzureKubernetesEnvironmentResource

Handle

📦 Aspire.Hosting.Azure.Kubernetes v13.3.0-preview.1.26254.5

interface AzureKubernetesEnvironmentResource
  extends IAzureResource,
    IComputeEnvironmentResource,
    IResource,
    IResourceWithParameters,
    IAzureComputeEnvironmentResource,
    IAzureNspAssociationTarget {
  addGateway(name: string): KubernetesGatewayResource;
  addIngress(name: string): KubernetesIngressResource;
  addNodePool(
      name: string,
      vmSize?: string,
      minCount?: number,
      maxCount?: number): AksNodePoolResource;
  withContainerRegistry(registry: AzureContainerRegistryResource): AzureKubernetesEnvironmentResource;
  withSubnet(subnet: AzureSubnetResource): AzureKubernetesEnvironmentResource;
  withSystemNodePool(
      vmSize?: string,
      minCount?: number,
      maxCount?: number): AzureKubernetesEnvironmentResource;
  withWorkloadIdentity(enabled?: boolean): AzureKubernetesEnvironmentResource;
}

7 members

Methods

method addGateway builder

Adds a Kubernetes Gateway API Gateway to an AKS environment

addGateway(name: string): KubernetesGatewayResource

Parameters

name string

Returns

KubernetesGatewayResource

method addIngress builder

Adds a Kubernetes Ingress resource to an AKS environment

addIngress(name: string): KubernetesIngressResource

Parameters

name string

Returns

KubernetesIngressResource

method addNodePool builder

Adds a node pool to the AKS cluster

addNodePool(
    name: string,
    vmSize?: string,
    minCount?: number,
    maxCount?: number): AksNodePoolResource

Parameters

name string

vmSize string optional = Standard_D2s_v5

minCount number optional = 1

maxCount number optional = 3

Returns

AksNodePoolResource

method withContainerRegistry builder

Configures the AKS environment to use a specific container registry

withContainerRegistry(registry: AzureContainerRegistryResource): AzureKubernetesEnvironmentResource

Parameters

registry AzureContainerRegistryResource

Returns

AzureKubernetesEnvironmentResource

method withSubnet builder

Configures the AKS cluster to use a VNet subnet

withSubnet(subnet: AzureSubnetResource): AzureKubernetesEnvironmentResource

Parameters

subnet AzureSubnetResource

Returns

AzureKubernetesEnvironmentResource

method withSystemNodePool builder

Replaces the default system node pool with a customized configuration

withSystemNodePool(
    vmSize?: string,
    minCount?: number,
    maxCount?: number): AzureKubernetesEnvironmentResource

Parameters

vmSize string optional = Standard_D2s_v5

minCount number optional = 1

maxCount number optional = 3

Returns

AzureKubernetesEnvironmentResource

method withWorkloadIdentity builder

Enables workload identity on the AKS cluster

withWorkloadIdentity(enabled?: boolean): AzureKubernetesEnvironmentResource

Parameters

enabled boolean optional = True

Returns

AzureKubernetesEnvironmentResource