AzureKubernetesEnvironmentResource
type AzureKubernetesEnvironmentResource interface { ComputeEnvironmentResource Resource}Methods
AddCertManager( name string, options ...*AddCertManagerOptions,) CertManagerResourceParameters
namestringThe Aspire resource name for the cert-manager installation.options...*AddCertManagerOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*AddCertManagerOptions argument.
ChartVersion *stringThe cert-manager Helm chart version to install. Defaults to a pinned version validated against this Aspire build.Returns
CertManagerResource The resource builder.
Returns a handle; failures surface later via Err().
AddGateway(name string) KubernetesGatewayResourceParameters
namestringThe name of the gateway resource.Returns
KubernetesGatewayResource The resource builder.
Returns a handle; failures surface later via Err().
helm upgrade --install as a pipeline step after the main application Helm chart is deployed.AddHelmChart( name string, chartReference string, chartVersion string,) KubernetesHelmChartResourceParameters
namestringThe name of the Helm chart resource.chartReference stringThe Helm chart reference. Can be an OCI registry URL (e.g., oci://quay.io/jetstack/charts/cert-manager ) or a chart name from an added repository.chartVersion stringThe chart version to install.Returns
KubernetesHelmChartResource A resource builder for the Helm chart resource.
Returns a handle; failures surface later via Err().
networking.k8s.io/v1 Ingress resource in the Helm chart output at publish time.AddIngress(name string) KubernetesIngressResourceParameters
namestringThe name of the ingress resource.Returns
KubernetesIngressResource The resource builder.
Returns a handle; failures surface later via Err().
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,) AzureKubernetesLoadBalancerResourceParameters
namestringThe name of the load balancer resource. Used to derive the in-cluster ApplicationLoadBalancer name (alb-{name} ) referenced by gateway/ingress annotations.subnetAzureSubnetResource A subnet that will be associated with the AGC ALB. The subnet is automatically delegated to Microsoft.ServiceNetworking/trafficControllers ; this is required by AGC and is idempotent across multiple AddLoadBalancer calls against the same subnet.Returns
AzureKubernetesLoadBalancerResource The resource builder.
Returns a handle; failures surface later via Err().
AddNodePool( name string, configure func(obj *AksNodePoolConfig),) AksNodePoolResourceParameters
namestringThe name of the node pool.configurefunc(obj *AksNodePoolConfig) callbackA callback to configure VM size, autoscaling, and OS SKU.Returns
AksNodePoolResource The resource builder for the new node pool.
Returns a handle; failures surface later via Err().
AddPersistentVolume(name string) KubernetesPersistentVolumeResourceParameters
namestringThe name of the persistent volume resource.Returns
KubernetesPersistentVolumeResource The resource builder.
Returns a handle; failures surface later via Err().
WithContainerRegistry(registry AzureContainerRegistryResource) AzureKubernetesEnvironmentResourceParameters
registryAzureContainerRegistryResource The Azure Container Registry resource builder.Returns
AzureKubernetesEnvironmentResource The resource builder.
Returns a handle; failures surface later via Err().
WithSubnet(subnet AzureSubnetResource) AzureKubernetesEnvironmentResourceParameters
subnetAzureSubnetResource The subnet to use for AKS node pools.Returns
AzureKubernetesEnvironmentResource The resource builder.
Returns a handle; failures surface later via Err().
WithSystemNodePool(configure func(obj *AksNodePoolConfig)) AzureKubernetesEnvironmentResourceParameters
configurefunc(obj *AksNodePoolConfig) callbackA callback to configure VM size, autoscaling, and OS SKU.Returns
AzureKubernetesEnvironmentResource The AKS environment resource builder for chaining.
Returns a handle; failures surface later via Err().
WithWorkloadIdentity(options ...*WithWorkloadIdentityOptions) AzureKubernetesEnvironmentResourceParameters
options...*WithWorkloadIdentityOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*WithWorkloadIdentityOptions argument.
Enabled*booltrue to enable workload identity (the default); false to disable it.Returns
AzureKubernetesEnvironmentResource The resource builder.
Returns a handle; failures surface later via Err().