containerservice.azure.com/v1api20240402preview

"2024-04-02-preview"

Observability: Observability profile to enable advanced network metrics and flow logs with historical contexts.

Enabled: Indicates the enablement of Advanced Networking observability functionalities on clusters.

Enabled: Indicates the enablement of Advanced Networking observability functionalities on clusters.

Observability: Observability profile to enable advanced network metrics and flow logs with historical contexts.

Enabled: Artifact streaming speeds up the cold-start of containers on a node through on-demand image loading. To use this feature, container images must also enable artifact streaming on ACR. If not specified, the default is false.

Enabled: Artifact streaming speeds up the cold-start of containers on a node through on-demand image loading. To use this feature, container images must also enable artifact streaming on ACR. If not specified, the default is false.

InstallGPUDriver: The default value is true when the vmSize of the agent pool contains a GPU, false otherwise. GPU Driver Installation can only be set true when VM has an associated GPU resource. Setting this field to false prevents automatic GPU driver installation. In that case, in order for the GPU to be usable, the user must perform GPU driver installation themselves.

InstallGPUDriver: The default value is true when the vmSize of the agent pool contains a GPU, false otherwise. GPU Driver Installation can only be set true when VM has an associated GPU resource. Setting this field to false prevents automatic GPU driver installation. In that case, in order for the GPU to be usable, the user must perform GPU driver installation themselves.

PublicIPPrefixSize: The Gateway agent pool associates one public IPPrefix for each static egress gateway to provide public egress. The size of Public IPPrefix should be selected by the user. Each node in the agent pool is assigned with one IP from the IPPrefix. The IPPrefix size thus serves as a cap on the size of the Gateway agent pool. Due to Azure public IPPrefix size limitation, the valid value range is 28, 31. The default value is 31.

PublicIPPrefixSize: The Gateway agent pool associates one public IPPrefix for each static egress gateway to provide public egress. The size of Public IPPrefix should be selected by the user. Each node in the agent pool is assigned with one IP from the IPPrefix. The IPPrefix size thus serves as a cap on the size of the Gateway agent pool. Due to Azure public IPPrefix size limitation, the valid value range is 28, 31. The default value is 31.

"Gateway"

"System"

"User"

"Gateway"

"System"

"User"

AllowedHostPorts: The port ranges that are allowed to access. The specified ranges are allowed to overlap.

ApplicationSecurityGroupsReferences: The IDs of the application security groups which agent pool will associate when created.

NodePublicIPTags: IPTags of instance-level public IPs.

AllowedHostPorts: The port ranges that are allowed to access. The specified ranges are allowed to overlap.

ApplicationSecurityGroups: The IDs of the application security groups which agent pool will associate when created.

NodePublicIPTags: IPTags of instance-level public IPs.

"Disabled"

"LocalUser"

"Disabled"

"LocalUser"

EnableSecureBoot: Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false.

EnableVTPM: vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false.

SshAccess: SSH access method of an agent pool.

EnableSecureBoot: Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false.

EnableVTPM: vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false.

SshAccess: SSH access method of an agent pool.

"AvailabilitySet"

"VirtualMachineScaleSets"

"VirtualMachines"

"AvailabilitySet"

"VirtualMachineScaleSets"

"VirtualMachines"

DrainTimeoutInMinutes: The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes.

MaxSurge: This can either be set to an integer (e.g. ‘5’) or a percentage (e.g. ‘50%’). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade

NodeSoakDurationInMinutes: The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes.

UndrainableNodeBehavior: Defines the behavior for undrainable nodes during upgrade. The most common cause of undrainable nodes is Pod Disruption Budgets (PDBs), but other issues, such as pod termination grace period is exceeding the remaining per-node drain timeout or pod is still being in a running state, can also cause undrainable nodes.

DrainTimeoutInMinutes: The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes.

MaxSurge: This can either be set to an integer (e.g. ‘5’) or a percentage (e.g. ‘50%’). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade

NodeSoakDurationInMinutes: The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes.

UndrainableNodeBehavior: Defines the behavior for undrainable nodes during upgrade. The most common cause of undrainable nodes is Pod Disruption Budgets (PDBs), but other issues, such as pod termination grace period is exceeding the remaining per-node drain timeout or pod is still being in a running state, can also cause undrainable nodes.

"Cordon"

"Schedule"

"Cordon"

"Schedule"

DisableOutboundNat: The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled.

DisableOutboundNat: The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled.

MaxCount: The maximum number of nodes of the specified sizes.

MinCount: The minimum number of nodes of the specified sizes.

Sizes: The list of allowed vm sizes e.g. [‘Standard_E4s_v3’, ‘Standard_E16s_v3’, ‘Standard_D16s_v5’]. AKS will use the first available one when auto scaling. If a VM size is unavailable (e.g. due to quota or regional capacity reasons), AKS will use the next size.

MaxCount: The maximum number of nodes of the specified sizes.

MinCount: The minimum number of nodes of the specified sizes.

Sizes: The list of allowed vm sizes e.g. [‘Standard_E4s_v3’, ‘Standard_E16s_v3’, ‘Standard_D16s_v5’]. AKS will use the first available one when auto scaling. If a VM size is unavailable (e.g. due to quota or regional capacity reasons), AKS will use the next size.

Enabled: Whether to enable Azure Key Vault key management service. The default is false.

KeyId: Identifier of Azure Key Vault key. See key identifier format for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty.

KeyVaultNetworkAccess: Network access of key vault. The possible values are Public and Private. Public means the key vault allows public access from all networks. Private means the key vault disables public access and enables private link. The default value is Public.

KeyVaultResourceReference: Resource ID of key vault. When keyVaultNetworkAccess is Private, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is Public, leave the field empty.

"Private"

"Public"

"Private"

"Public"

Enabled: Whether to enable Azure Key Vault key management service. The default is false.

KeyId: Identifier of Azure Key Vault key. See key identifier format for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty.

KeyVaultNetworkAccess: Network access of key vault. The possible values are Public and Private. Public means the key vault allows public access from all networks. Private means the key vault disables public access and enables private link. The default value is Public.

KeyVaultResourceId: Resource ID of key vault. When keyVaultNetworkAccess is Private, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is Public, leave the field empty.

OverrideSettings: Settings for overrides.

OverrideSettings: Settings for overrides.

AdminUsername: The administrator username to use for Linux VMs.

Ssh: The SSH configuration for Linux-based VMs running on Azure.

AdminUsername: The administrator username to use for Linux VMs.

Ssh: The SSH configuration for Linux-based VMs running on Azure.

AdvancedNetworking: Advanced Networking profile for enabling observability on a cluster. Note that enabling advanced networking features may incur additional costs. For more information see aka.ms/aksadvancednetworking.

DnsServiceIP: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.

IpFamilies: IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6.

KubeProxyConfig: Holds configuration customizations for kube-proxy. Any values not defined will use the kube-proxy defaulting behavior. See https://v.docs.kubernetes.io/docs/reference/command-line-tools-reference/kube-proxy/ where is represented by a - string. Kubernetes version 1.23 would be ‘1-23’.

LoadBalancerProfile: Profile of the cluster load balancer.

LoadBalancerSku: The default is ‘standard’. See Azure Load Balancer SKUs for more information about the differences between load balancer SKUs.

NatGatewayProfile: Profile of the cluster NAT gateway.

NetworkDataplane: Network dataplane used in the Kubernetes cluster.

NetworkMode: This cannot be specified if networkPlugin is anything other than ‘azure’.

NetworkPlugin: Network plugin used for building the Kubernetes network.

NetworkPluginMode: Network plugin mode used for building the Kubernetes network.

NetworkPolicy: Network policy used for building the Kubernetes network.

OutboundType: This can only be set at cluster creation time and cannot be changed later. For more information see egress outbound type.

PodCidr: A CIDR notation IP range from which to assign pod IPs when kubenet is used.

PodCidrs: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking.

PodLinkLocalAccess: Defines access to special link local addresses (Azure Instance Metadata Service, aka IMDS) for pods with hostNetwork=false. if not specified, the default is ‘IMDS’.

ServiceCidr: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.

ServiceCidrs: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges.

StaticEgressGatewayProfile: The profile for Static Egress Gateway addon. For more details about Static Egress Gateway, see https://aka.ms/aks/static-egress-gateway.

Enabled: Whether to enable on kube-proxy on the cluster (if no ‘kubeProxyConfig’ exists, kube-proxy is enabled in AKS by default without these customizations).

IpvsConfig: Holds configuration customizations for IPVS. May only be specified if ‘mode’ is set to ‘IPVS’.

Mode: Specify which proxy mode to use (‘IPTABLES’ or ‘IPVS’)

Scheduler: IPVS scheduler, for more information please see http://www.linuxvirtualserver.org/docs/scheduling.html.

TcpFinTimeoutSeconds: The timeout value used for IPVS TCP sessions after receiving a FIN in seconds. Must be a positive integer value.

TcpTimeoutSeconds: The timeout value used for idle IPVS TCP sessions in seconds. Must be a positive integer value.

UdpTimeoutSeconds: The timeout value used for IPVS UDP packets in seconds. Must be a positive integer value.

Scheduler: IPVS scheduler, for more information please see http://www.linuxvirtualserver.org/docs/scheduling.html.

TcpFinTimeoutSeconds: The timeout value used for IPVS TCP sessions after receiving a FIN in seconds. Must be a positive integer value.

TcpTimeoutSeconds: The timeout value used for idle IPVS TCP sessions in seconds. Must be a positive integer value.

UdpTimeoutSeconds: The timeout value used for IPVS UDP packets in seconds. Must be a positive integer value.

"LeastConnection"

"RoundRobin"

"LeastConnection"

"RoundRobin"

"IPTABLES"

"IPVS"

"IPTABLES"

"IPVS"

Enabled: Whether to enable on kube-proxy on the cluster (if no ‘kubeProxyConfig’ exists, kube-proxy is enabled in AKS by default without these customizations).

IpvsConfig: Holds configuration customizations for IPVS. May only be specified if ‘mode’ is set to ‘IPVS’.

Mode: Specify which proxy mode to use (‘IPTABLES’ or ‘IPVS’)

"loadBalancer"

"managedNATGateway"

"none"

"userAssignedNATGateway"

"userDefinedRouting"

"loadBalancer"

"managedNATGateway"

"none"

"userAssignedNATGateway"

"userDefinedRouting"

AdvancedNetworking: Advanced Networking profile for enabling observability on a cluster. Note that enabling advanced networking features may incur additional costs. For more information see aka.ms/aksadvancednetworking.

DnsServiceIP: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.

IpFamilies: IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6.

KubeProxyConfig: Holds configuration customizations for kube-proxy. Any values not defined will use the kube-proxy defaulting behavior. See https://v.docs.kubernetes.io/docs/reference/command-line-tools-reference/kube-proxy/ where is represented by a - string. Kubernetes version 1.23 would be ‘1-23’.

LoadBalancerProfile: Profile of the cluster load balancer.

LoadBalancerSku: The default is ‘standard’. See Azure Load Balancer SKUs for more information about the differences between load balancer SKUs.

NatGatewayProfile: Profile of the cluster NAT gateway.

NetworkDataplane: Network dataplane used in the Kubernetes cluster.

NetworkMode: This cannot be specified if networkPlugin is anything other than ‘azure’.

NetworkPlugin: Network plugin used for building the Kubernetes network.

NetworkPluginMode: Network plugin mode used for building the Kubernetes network.

NetworkPolicy: Network policy used for building the Kubernetes network.

OutboundType: This can only be set at cluster creation time and cannot be changed later. For more information see egress outbound type.

PodCidr: A CIDR notation IP range from which to assign pod IPs when kubenet is used.

PodCidrs: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking.

PodLinkLocalAccess: Defines access to special link local addresses (Azure Instance Metadata Service, aka IMDS) for pods with hostNetwork=false. if not specified, the default is ‘IMDS’.

ServiceCidr: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.

ServiceCidrs: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges.

StaticEgressGatewayProfile: The profile for Static Egress Gateway addon. For more details about Static Egress Gateway, see https://aka.ms/aks/static-egress-gateway.

PublicKeys: The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified.

PublicKeys: The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified.

KeyData: Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers.

KeyData: Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers.

SourceResourceReference: This is the ARM ID of the source object to be used to create the target object.

SourceResourceId: This is the ARM ID of the source object to be used to create the target object.

Location: The source resource location - internal use only.

ReferralResource: The delegation id of the referral delegation (optional) - internal use only.

ResourceReference: The ARM resource id of the delegated resource - internal use only.

TenantId: The tenant id of the delegated resource - internal use only.

Location: The source resource location - internal use only.

ReferralResource: The delegation id of the referral delegation (optional) - internal use only.

ResourceId: The ARM resource id of the delegated resource - internal use only.

TenantId: The tenant id of the delegated resource - internal use only.

"least-waste"

"most-pods"

"priority"

"random"

"least-waste"

"most-pods"

"priority"

"random"

Name: The name of the extended location.

Type: The type of the extended location.

"EdgeZone"

"EdgeZone"

Name: The name of the extended location.

Type: The type of the extended location.

"MIG1g"

"MIG2g"

"MIG3g"

"MIG4g"

"MIG7g"

"MIG1g"

"MIG2g"

"MIG3g"

"MIG4g"

"MIG7g"

IpTagType: The IP tag type. Example: RoutingPreference.

Tag: The value of the IP tag associated with the public IP. Example: Internet.

IpTagType: The IP tag type. Example: RoutingPreference.

Tag: The value of the IP tag associated with the public IP. Example: Internet.

"IPv4"

"IPv6"

"IPv4"

"IPv6"

Plugin: Plugin certificates information for Service Mesh.

Plugin: Plugin certificates information for Service Mesh.

EgressGateways: Istio egress gateways.

IngressGateways: Istio ingress gateways.

EgressGateways: Istio egress gateways.

IngressGateways: Istio ingress gateways.

Enabled: Whether to enable the egress gateway.

Enabled: Whether to enable the egress gateway.

Enabled: Whether to enable the ingress gateway.

Mode: Mode of an ingress gateway.

"External"

"Internal"

"External"

"Internal"

Enabled: Whether to enable the ingress gateway.

Mode: Mode of an ingress gateway.

CertChainObjectName: Certificate chain object name in Azure Key Vault.

CertObjectName: Intermediate certificate object name in Azure Key Vault.

KeyObjectName: Intermediate certificate private key object name in Azure Key Vault.

KeyVaultReference: The resource ID of the Key Vault.

RootCertObjectName: Root certificate object name in Azure Key Vault.

CertChainObjectName: Certificate chain object name in Azure Key Vault.

CertObjectName: Intermediate certificate object name in Azure Key Vault.

KeyObjectName: Intermediate certificate private key object name in Azure Key Vault.

KeyVaultId: The resource ID of the Key Vault.

RootCertObjectName: Root certificate object name in Azure Key Vault.

CertificateAuthority: Istio Service Mesh Certificate Authority (CA) configuration. For now, we only support plugin certificates as described here https://aka.ms/asm-plugin-ca

Components: Istio components configuration.

Revisions: The list of revisions of the Istio control plane. When an upgrade is not in progress, this holds one value. When canary upgrade is in progress, this can only hold two consecutive values. For more information, see: https://learn.microsoft.com/en-us/azure/aks/istio-upgrade

CertificateAuthority: Istio Service Mesh Certificate Authority (CA) configuration. For now, we only support plugin certificates as described here https://aka.ms/asm-plugin-ca

Components: Istio components configuration.

Revisions: The list of revisions of the Istio control plane. When an upgrade is not in progress, this holds one value. When canary upgrade is in progress, this can only hold two consecutive values. For more information, see: https://learn.microsoft.com/en-us/azure/aks/istio-upgrade

AllowedUnsafeSysctls: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in *).

ContainerLogMaxFiles: The maximum number of container log files that can be present for a container. The number must be ≥ 2.

ContainerLogMaxSizeMB: The maximum size (e.g. 10Mi) of container log file before it is rotated.

CpuCfsQuota: The default is true.

CpuCfsQuotaPeriod: The default is ‘100ms.’ Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: ‘300ms’, ‘2h45m’. Supported units are ‘ns’, ‘us’, ‘ms’, ’s’, ’m’, and ‘h’.

CpuManagerPolicy: The default is ‘none’. See Kubernetes CPU management policies for more information. Allowed values are ‘none’ and ‘static’.

FailSwapOn: If set to true it will make the Kubelet fail to start if swap is enabled on the node.

ImageGcHighThreshold: To disable image garbage collection, set to 100. The default is 85%

ImageGcLowThreshold: This cannot be set higher than imageGcHighThreshold. The default is 80%

PodMaxPids: The maximum number of processes per pod.

TopologyManagerPolicy: For more information see Kubernetes Topology Manager. The default is ‘none’. Allowed values are ‘none’, ‘best-effort’, ‘restricted’, and ‘single-numa-node’.

AllowedUnsafeSysctls: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in *).

ContainerLogMaxFiles: The maximum number of container log files that can be present for a container. The number must be ≥ 2.

ContainerLogMaxSizeMB: The maximum size (e.g. 10Mi) of container log file before it is rotated.

CpuCfsQuota: The default is true.

CpuCfsQuotaPeriod: The default is ‘100ms.’ Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: ‘300ms’, ‘2h45m’. Supported units are ‘ns’, ‘us’, ‘ms’, ’s’, ’m’, and ‘h’.

CpuManagerPolicy: The default is ‘none’. See Kubernetes CPU management policies for more information. Allowed values are ‘none’ and ‘static’.

FailSwapOn: If set to true it will make the Kubelet fail to start if swap is enabled on the node.

ImageGcHighThreshold: To disable image garbage collection, set to 100. The default is 85%

ImageGcLowThreshold: This cannot be set higher than imageGcHighThreshold. The default is 80%

PodMaxPids: The maximum number of processes per pod.

TopologyManagerPolicy: For more information see Kubernetes Topology Manager. The default is ‘none’. Allowed values are ‘none’, ‘best-effort’, ‘restricted’, and ‘single-numa-node’.

"OS"

"Temporary"

"OS"

"Temporary"

"AKSLongTermSupport"

"KubernetesOfficial"

"AKSLongTermSupport"

"KubernetesOfficial"

SwapFileSizeMB: The size in MB of a swap file that will be created on each node.

Sysctls: Sysctl settings for Linux agent nodes.

TransparentHugePageDefrag: Valid values are ‘always’, ‘defer’, ‘defer+madvise’, ‘madvise’ and ‘never’. The default is ‘madvise’. For more information see Transparent Hugepages.

TransparentHugePageEnabled: Valid values are ‘always’, ‘madvise’, and ‘never’. The default is ‘always’. For more information see Transparent Hugepages.

SwapFileSizeMB: The size in MB of a swap file that will be created on each node.

Sysctls: Sysctl settings for Linux agent nodes.

TransparentHugePageDefrag: Valid values are ‘always’, ‘defer’, ‘defer+madvise’, ‘madvise’ and ‘never’. The default is ‘madvise’. For more information see Transparent Hugepages.

TransparentHugePageEnabled: Valid values are ‘always’, ‘madvise’, and ‘never’. The default is ‘always’. For more information see Transparent Hugepages.

"basic"

"standard"

"basic"

"standard"

AdminGroupObjectIDs: The list of AAD group object IDs that will have admin role of the cluster.

ClientAppID: (DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy.

EnableAzureRBAC: Whether to enable Azure RBAC for Kubernetes authorization.

Managed: Whether to enable managed AAD.

ServerAppID: (DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy.

ServerAppSecret: (DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy.

TenantID: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription.

AdminGroupObjectIDs: The list of AAD group object IDs that will have admin role of the cluster.

ClientAppID: (DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy.

EnableAzureRBAC: Whether to enable Azure RBAC for Kubernetes authorization.

Managed: Whether to enable managed AAD.

ServerAppID: (DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy.

ServerAppSecret: (DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy.

TenantID: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription.

Enabled: Indicates if AI toolchain operator enabled or not.

Enabled: Indicates if AI toolchain operator enabled or not.

AuthorizedIPRanges: IP ranges are specified in CIDR format, e.g. 137.117.106.⁸⁸⁄₂₉. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see API server authorized IP ranges.

DisableRunCommand: Whether to disable run command for the cluster or not.

EnablePrivateCluster: For more details, see Creating a private AKS cluster.

EnablePrivateClusterPublicFQDN: Whether to create additional public FQDN for private cluster or not.

EnableVnetIntegration: Whether to enable apiserver vnet integration for the cluster or not.

PrivateDNSZone: The default is System. For more details see configure private DNS zone. Allowed values are ‘system’ and ‘none’.

SubnetId: It is required when: 1. creating a new cluster with BYO Vnet; 2. updating an existing cluster to enable apiserver vnet integration.

AuthorizedIPRanges: IP ranges are specified in CIDR format, e.g. 137.117.106.⁸⁸⁄₂₉. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see API server authorized IP ranges.

DisableRunCommand: Whether to disable run command for the cluster or not.

EnablePrivateCluster: For more details, see Creating a private AKS cluster.

EnablePrivateClusterPublicFQDN: Whether to create additional public FQDN for private cluster or not.

EnableVnetIntegration: Whether to enable apiserver vnet integration for the cluster or not.

PrivateDNSZone: The default is System. For more details see configure private DNS zone. Allowed values are ‘system’ and ‘none’.

SubnetId: It is required when: 1. creating a new cluster with BYO Vnet; 2. updating an existing cluster to enable apiserver vnet integration.

Config: Key-value pairs for configuring an add-on.

Enabled: Whether the add-on is enabled or not.

Config: Key-value pairs for configuring an add-on.

Enabled: Whether the add-on is enabled or not.

Identity: Information of user assigned identity used by this add-on.

ArtifactStreamingProfile: Configuration for using artifact streaming on AKS.

AvailabilityZones: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is ‘VirtualMachineScaleSets’.

CapacityReservationGroupReference: AKS will associate the specified agent pool with the Capacity Reservation Group.

Count: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1.

CreationData: CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot.

EnableAutoScaling: Whether to enable auto-scaler

EnableCustomCATrust: When set to true, AKS adds a label to the node indicating that the feature is enabled and deploys a daemonset along with host services to sync custom certificate authorities from user-provided list of base64 encoded certificates into node trust stores. Defaults to false.

EnableEncryptionAtHost: This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption

EnableFIPS: See Add a FIPS-enabled node pool for more details.

EnableNodePublicIP: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see assigning a public IP per node. The default is false.

EnableUltraSSD: Whether to enable UltraSSD

GatewayProfile: Profile specific to a managed agent pool in Gateway mode. This field cannot be set if agent pool mode is not Gateway.

GpuInstanceProfile: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.

GpuProfile: The GPU settings of an agent pool.

HostGroupReference: This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Compute/​hostGroups/​{hostGroupName}. For more information see Azure dedicated hosts.

KubeletConfig: The Kubelet configuration on the agent pool nodes.

KubeletDiskType: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.

LinuxOSConfig: The OS configuration of Linux agent nodes.

MaxCount: The maximum number of nodes for auto-scaling

MaxPods: The maximum number of pods that can run on a node.

MessageOfTheDay: A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script).

MinCount: The minimum number of nodes for auto-scaling

Mode: A cluster must have at least one ‘System’ Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools

Name: Windows agent pool names must be 6 characters or less.

NetworkProfile: Network-related settings of an agent pool.

NodeInitializationTaints: These taints will not be reconciled by AKS and can be removed with a kubectl call. This field can be modified after node pool is created, but nodes will not be recreated with new taints until another operation that requires recreation (e.g. node image upgrade) happens. These taints allow for required configuration to run before the node is ready to accept workloads, for example ‘key1=value1:NoSchedule’ that then can be removed with kubectl taint nodes node1 key1=value1:NoSchedule-

NodeLabels: The node labels to be persisted across all nodes in agent pool.

NodePublicIPPrefixReference: This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/​publicIPPrefixes/​{publicIPPrefixName}

NodeTaints: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.

OrchestratorVersion: Both patch version and are supported. When is specified, the latest supported patch version is chosen automatically. Updating the agent pool with the same once it has been created will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see upgrading a node pool.

OsDiskType: The default is ‘Ephemeral’ if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to ‘Managed’. May not be changed after creation. For more information see Ephemeral OS.

OsSKU: Specifies the OS SKU used by the agent pool. If not specified, the default is Ubuntu if OSType=Linux or Windows2019 if OSType=Windows. And the default Windows OSSKU will be changed to Windows2022 after Windows2019 is deprecated.

OsType: The operating system type. The default is Linux.

PodIPAllocationMode: The IP allocation mode for pods in the agent pool. Must be used with podSubnetId. The default is ‘DynamicIndividual’.

PodSubnetReference: If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/​virtualNetworks/​{virtualNetworkName}/​subnets/​{subnetName}

PowerState: When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded

ProximityPlacementGroupReference: The ID for Proximity Placement Group.

ScaleDownMode: This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.

ScaleSetEvictionPolicy: This cannot be specified unless the scaleSetPriority is ‘Spot’. If not specified, the default is ‘Delete’.

ScaleSetPriority: The Virtual Machine Scale Set priority. If not specified, the default is ‘Regular’.

SecurityProfile: The security settings of an agent pool.

SpotMaxPrice: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see spot VMs pricing

Tags: The tags to be persisted on the agent pool virtual machine scale set.

Type: The type of Agent Pool.

UpgradeSettings: Settings for upgrading the agentpool

VirtualMachinesProfile: Specifications on VirtualMachines agent pool.

VmSize: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions

VnetSubnetReference: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/​virtualNetworks/​{virtualNetworkName}/​subnets/​{subnetName}

WindowsProfile: The Windows agent pool’s specific profile.

WorkloadRuntime: Determines the type of workload a node can run.

ArtifactStreamingProfile: Configuration for using artifact streaming on AKS.

AvailabilityZones: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is ‘VirtualMachineScaleSets’.

CapacityReservationGroupID: AKS will associate the specified agent pool with the Capacity Reservation Group.

Count: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1.

CreationData: CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot.

CurrentOrchestratorVersion: If orchestratorVersion was a fully specified version , this field will be exactly equal to it. If orchestratorVersion was , this field will contain the full version being used.

ETag: Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention.

EnableAutoScaling: Whether to enable auto-scaler

EnableCustomCATrust: When set to true, AKS adds a label to the node indicating that the feature is enabled and deploys a daemonset along with host services to sync custom certificate authorities from user-provided list of base64 encoded certificates into node trust stores. Defaults to false.

EnableEncryptionAtHost: This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption

EnableFIPS: See Add a FIPS-enabled node pool for more details.

EnableNodePublicIP: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see assigning a public IP per node. The default is false.

EnableUltraSSD: Whether to enable UltraSSD

GatewayProfile: Profile specific to a managed agent pool in Gateway mode. This field cannot be set if agent pool mode is not Gateway.

GpuInstanceProfile: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.

GpuProfile: The GPU settings of an agent pool.

HostGroupID: This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Compute/​hostGroups/​{hostGroupName}. For more information see Azure dedicated hosts.

KubeletConfig: The Kubelet configuration on the agent pool nodes.

KubeletDiskType: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.

LinuxOSConfig: The OS configuration of Linux agent nodes.

MaxCount: The maximum number of nodes for auto-scaling

MaxPods: The maximum number of pods that can run on a node.

MessageOfTheDay: A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script).

MinCount: The minimum number of nodes for auto-scaling

Mode: A cluster must have at least one ‘System’ Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools

Name: Windows agent pool names must be 6 characters or less.

NetworkProfile: Network-related settings of an agent pool.

NodeImageVersion: The version of node image

NodeInitializationTaints: These taints will not be reconciled by AKS and can be removed with a kubectl call. This field can be modified after node pool is created, but nodes will not be recreated with new taints until another operation that requires recreation (e.g. node image upgrade) happens. These taints allow for required configuration to run before the node is ready to accept workloads, for example ‘key1=value1:NoSchedule’ that then can be removed with kubectl taint nodes node1 key1=value1:NoSchedule-

NodeLabels: The node labels to be persisted across all nodes in agent pool.

NodePublicIPPrefixID: This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/​publicIPPrefixes/​{publicIPPrefixName}

NodeTaints: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.

OrchestratorVersion: Both patch version and are supported. When is specified, the latest supported patch version is chosen automatically. Updating the agent pool with the same once it has been created will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see upgrading a node pool.

OsDiskType: The default is ‘Ephemeral’ if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to ‘Managed’. May not be changed after creation. For more information see Ephemeral OS.

OsSKU: Specifies the OS SKU used by the agent pool. If not specified, the default is Ubuntu if OSType=Linux or Windows2019 if OSType=Windows. And the default Windows OSSKU will be changed to Windows2022 after Windows2019 is deprecated.

OsType: The operating system type. The default is Linux.

PodIPAllocationMode: The IP allocation mode for pods in the agent pool. Must be used with podSubnetId. The default is ‘DynamicIndividual’.

PodSubnetID: If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/​virtualNetworks/​{virtualNetworkName}/​subnets/​{subnetName}

PowerState: When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded

ProvisioningState: The current deployment or provisioning state.

ProximityPlacementGroupID: The ID for Proximity Placement Group.

ScaleDownMode: This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.

ScaleSetEvictionPolicy: This cannot be specified unless the scaleSetPriority is ‘Spot’. If not specified, the default is ‘Delete’.

ScaleSetPriority: The Virtual Machine Scale Set priority. If not specified, the default is ‘Regular’.

SecurityProfile: The security settings of an agent pool.

SpotMaxPrice: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see spot VMs pricing

Tags: The tags to be persisted on the agent pool virtual machine scale set.

Type: The type of Agent Pool.

UpgradeSettings: Settings for upgrading the agentpool

VirtualMachinesProfile: Specifications on VirtualMachines agent pool.

VmSize: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions

VnetSubnetID: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/​virtualNetworks/​{virtualNetworkName}/​subnets/​{subnetName}

WindowsProfile: The Windows agent pool’s specific profile.

WorkloadRuntime: Determines the type of workload a node can run.

NodeOSUpgradeChannel: The default is Unmanaged, but may change to either NodeImage or SecurityPatch at GA.

UpgradeChannel: For more information see setting the AKS cluster auto-upgrade channel.

"NodeImage"

"None"

"SecurityPatch"

"Unmanaged"

"NodeImage"

"None"

"SecurityPatch"

"Unmanaged"

NodeOSUpgradeChannel: The default is Unmanaged, but may change to either NodeImage or SecurityPatch at GA.

UpgradeChannel: For more information see setting the AKS cluster auto-upgrade channel.

"node-image"

"none"

"patch"

"rapid"

"stable"

"node-image"

"none"

"patch"

"rapid"

"stable"

AppMonitoring: Application Monitoring Profile for Kubernetes Application Container. Collects application logs, metrics and traces through auto-instrumentation of the application using Azure Monitor OpenTelemetry based SDKs. See aka.ms/AzureMonitorApplicationMonitoring for an overview.

ContainerInsights: Azure Monitor Container Insights Profile for Kubernetes Events, Inventory and Container stdout & stderr logs etc. See aka.ms/AzureMonitorContainerInsights for an overview.

Metrics: Metrics profile for the prometheus service addon

AutoInstrumentation: Application Monitoring Auto Instrumentation for Kubernetes Application Container. Deploys web hook to auto-instrument Azure Monitor OpenTelemetry based SDKs to collect OpenTelemetry metrics, logs and traces of the application. See aka.ms/AzureMonitorApplicationMonitoring for an overview.

OpenTelemetryLogs: Application Monitoring Open Telemetry Metrics Profile for Kubernetes Application Container Logs and Traces. Collects OpenTelemetry logs and traces of the application using Azure Monitor OpenTelemetry based SDKs. See aka.ms/AzureMonitorApplicationMonitoring for an overview.

OpenTelemetryMetrics: Application Monitoring Open Telemetry Metrics Profile for Kubernetes Application Container Metrics. Collects OpenTelemetry metrics of the application using Azure Monitor OpenTelemetry based SDKs. See aka.ms/AzureMonitorApplicationMonitoring for an overview.

Enabled: Indicates if Application Monitoring Auto Instrumentation is enabled or not.

Enabled: Indicates if Application Monitoring Auto Instrumentation is enabled or not.

Enabled: Indicates if Application Monitoring Open Telemetry Logs and traces is enabled or not.

Port: The Open Telemetry host port for Open Telemetry logs and traces. If not specified, the default port is 28331.

Enabled: Indicates if Application Monitoring Open Telemetry Logs and traces is enabled or not.

Port: The Open Telemetry host port for Open Telemetry logs and traces. If not specified, the default port is 28331.

Enabled: Indicates if Application Monitoring Open Telemetry Metrics is enabled or not.

Port: The Open Telemetry host port for Open Telemetry metrics. If not specified, the default port is 28333.

Enabled: Indicates if Application Monitoring Open Telemetry Metrics is enabled or not.

Port: The Open Telemetry host port for Open Telemetry metrics. If not specified, the default port is 28333.

AutoInstrumentation: Application Monitoring Auto Instrumentation for Kubernetes Application Container. Deploys web hook to auto-instrument Azure Monitor OpenTelemetry based SDKs to collect OpenTelemetry metrics, logs and traces of the application. See aka.ms/AzureMonitorApplicationMonitoring for an overview.

OpenTelemetryLogs: Application Monitoring Open Telemetry Metrics Profile for Kubernetes Application Container Logs and Traces. Collects OpenTelemetry logs and traces of the application using Azure Monitor OpenTelemetry based SDKs. See aka.ms/AzureMonitorApplicationMonitoring for an overview.

OpenTelemetryMetrics: Application Monitoring Open Telemetry Metrics Profile for Kubernetes Application Container Metrics. Collects OpenTelemetry metrics of the application using Azure Monitor OpenTelemetry based SDKs. See aka.ms/AzureMonitorApplicationMonitoring for an overview.

DisableCustomMetrics: Indicates whether custom metrics collection has to be disabled or not. If not specified the default is false. No custom metrics will be emitted if this field is false but the container insights enabled field is false

DisablePrometheusMetricsScraping: Indicates whether prometheus metrics scraping is disabled or not. If not specified the default is false. No prometheus metrics will be emitted if this field is false but the container insights enabled field is false

Enabled: Indicates if Azure Monitor Container Insights Logs Addon is enabled or not.

LogAnalyticsWorkspaceResourceReference: Fully Qualified ARM Resource Id of Azure Log Analytics Workspace for storing Azure Monitor Container Insights Logs.

SyslogPort: The syslog host port. If not specified, the default port is 28330.

DisableCustomMetrics: Indicates whether custom metrics collection has to be disabled or not. If not specified the default is false. No custom metrics will be emitted if this field is false but the container insights enabled field is false

DisablePrometheusMetricsScraping: Indicates whether prometheus metrics scraping is disabled or not. If not specified the default is false. No prometheus metrics will be emitted if this field is false but the container insights enabled field is false

Enabled: Indicates if Azure Monitor Container Insights Logs Addon is enabled or not.

LogAnalyticsWorkspaceResourceId: Fully Qualified ARM Resource Id of Azure Log Analytics Workspace for storing Azure Monitor Container Insights Logs.

SyslogPort: The syslog host port. If not specified, the default port is 28330.

MetricAnnotationsAllowList: Comma-separated list of additional Kubernetes label keys that will be used in the resource’s labels metric.

MetricLabelsAllowlist: Comma-separated list of Kubernetes annotations keys that will be used in the resource’s labels metric.

MetricAnnotationsAllowList: Comma-separated list of additional Kubernetes label keys that will be used in the resource’s labels metric.

MetricLabelsAllowlist: Comma-separated list of Kubernetes annotations keys that will be used in the resource’s labels metric.

Enabled: Whether to enable the Prometheus collector

KubeStateMetrics: Kube State Metrics for prometheus addon profile for the container service cluster

Enabled: Whether to enable the Prometheus collector

KubeStateMetrics: Kube State Metrics for prometheus addon profile for the container service cluster

AppMonitoring: Application Monitoring Profile for Kubernetes Application Container. Collects application logs, metrics and traces through auto-instrumentation of the application using Azure Monitor OpenTelemetry based SDKs. See aka.ms/AzureMonitorApplicationMonitoring for an overview.

ContainerInsights: Azure Monitor Container Insights Profile for Kubernetes Events, Inventory and Container stdout & stderr logs etc. See aka.ms/AzureMonitorContainerInsights for an overview.

Metrics: Metrics profile for the prometheus service addon

ArtifactSource: The source where the artifacts are downloaded from.

ContainerRegistryReference: The resource Id of Azure Container Registry. The registry must have private network access, premium SKU and zone redundancy.

"Cache"

"Direct"

"Cache"

"Direct"

ArtifactSource: The source where the artifacts are downloaded from.

ContainerRegistryId: The resource Id of Azure Container Registry. The registry must have private network access, premium SKU and zone redundancy.

Enabled: The Managed Cluster sku.tier must be set to ‘Standard’ or ‘Premium’ to enable this feature. Enabling this will add Kubernetes Namespace and Deployment details to the Cost Analysis views in the Azure portal. If not specified, the default is false. For more information see aka.ms/aks/docs/cost-analysis.

Enabled: The Managed Cluster sku.tier must be set to ‘Standard’ or ‘Premium’ to enable this feature. Enabling this will add Kubernetes Namespace and Deployment details to the Cost Analysis views in the Azure portal. If not specified, the default is false. For more information see aka.ms/aks/docs/cost-analysis.

HttpProxy: The HTTP proxy server endpoint to use.

HttpsProxy: The HTTPS proxy server endpoint to use.

NoProxy: The endpoints that should not go through proxy.

TrustedCa: Alternative CA cert to use for connecting to proxy servers.

EffectiveNoProxy: A read-only list of all endpoints for which traffic should not be sent to the proxy. This list is a superset of noProxy and values injected by AKS.

HttpProxy: The HTTP proxy server endpoint to use.

HttpsProxy: The HTTPS proxy server endpoint to use.

NoProxy: The endpoints that should not go through proxy.

TrustedCa: Alternative CA cert to use for connecting to proxy servers.

DelegatedResources: The delegated identity resources assigned to this managed cluster. This can only be set by another Azure Resource Provider, and managed cluster only accept one delegated identity resource. Internal use only.

Type: For more information see use managed identities in AKS.

UserAssignedIdentities: The keys must be ARM resource IDs in the form: ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ManagedIdentity/​userAssignedIdentities/​{identityName}’.

DelegatedResources: The delegated identity resources assigned to this managed cluster. This can only be set by another Azure Resource Provider, and managed cluster only accept one delegated identity resource. Internal use only.

PrincipalId: The principal id of the system assigned identity which is used by master components.

TenantId: The tenant id of the system assigned identity which is used by master components.

Type: For more information see use managed identities in AKS.

UserAssignedIdentities: The keys must be ARM resource IDs in the form: ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ManagedIdentity/​userAssignedIdentities/​{identityName}’.

"None"

"SystemAssigned"

"UserAssigned"

"None"

"SystemAssigned"

"UserAssigned"

ClientId: The client id of user assigned identity.

PrincipalId: The principal id of user assigned identity.

WebAppRouting: Web App Routing settings for the ingress profile.

DnsZoneResourceReferences: Resource IDs of the DNS zones to be associated with the Web App Routing add-on. Used only when Web App Routing is enabled. Public and private DNS zones can be in different resource groups, but all public DNS zones must be in the same resource group and all private DNS zones must be in the same resource group.

Enabled: Whether to enable Web App Routing.

DnsZoneResourceIds: Resource IDs of the DNS zones to be associated with the Web App Routing add-on. Used only when Web App Routing is enabled. Public and private DNS zones can be in different resource groups, but all public DNS zones must be in the same resource group and all private DNS zones must be in the same resource group.

Enabled: Whether to enable Web App Routing.

Identity: Managed identity of the Web Application Routing add-on. This is the identity that should be granted permissions, for example, to manage the associated Azure DNS resource and get certificates from Azure Key Vault. See this overview of the add-on for more instructions.

WebAppRouting: Web App Routing settings for the ingress profile.

AllocatedOutboundPorts: The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports.

BackendPoolType: The type of the managed inbound Load Balancer BackendPool.

ClusterServiceLoadBalancerHealthProbeMode: The health probing behavior for External Traffic Policy Cluster services.

EffectiveOutboundIPs: The effective outbound IP resources of the cluster load balancer.

EnableMultipleStandardLoadBalancers: Enable multiple standard load balancers per AKS cluster or not.

IdleTimeoutInMinutes: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes.

ManagedOutboundIPs: Desired managed outbound IPs for the cluster load balancer.

OutboundIPPrefixes: Desired outbound IP Prefix resources for the cluster load balancer.

OutboundIPs: Desired outbound IP resources for the cluster load balancer.

"NodeIP"

"NodeIPConfiguration"

"NodeIP"

"NodeIPConfiguration"

"ServiceNodePort"

"Shared"

"ServiceNodePort"

"Shared"

Count: The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.

CountIPv6: The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack.

Count: The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.

CountIPv6: The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack.

PublicIPPrefixes: A list of public IP prefix resources.

PublicIPPrefixes: A list of public IP prefix resources.

PublicIPs: A list of public IP resources.

PublicIPs: A list of public IP resources.

AllocatedOutboundPorts: The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports.

BackendPoolType: The type of the managed inbound Load Balancer BackendPool.

ClusterServiceLoadBalancerHealthProbeMode: The health probing behavior for External Traffic Policy Cluster services.

EffectiveOutboundIPs: The effective outbound IP resources of the cluster load balancer.

EnableMultipleStandardLoadBalancers: Enable multiple standard load balancers per AKS cluster or not.

IdleTimeoutInMinutes: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes.

ManagedOutboundIPs: Desired managed outbound IPs for the cluster load balancer.

OutboundIPPrefixes: Desired outbound IP Prefix resources for the cluster load balancer.

OutboundIPs: Desired outbound IP resources for the cluster load balancer.

Count: The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1.

Count: The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1.

CostAnalysis: The cost analysis configuration for the cluster

CostAnalysis: The cost analysis configuration for the cluster

EffectiveOutboundIPs: The effective outbound IP resources of the cluster NAT gateway.

IdleTimeoutInMinutes: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes.

ManagedOutboundIPProfile: Profile of the managed outbound IP resources of the cluster NAT gateway.

EffectiveOutboundIPs: The effective outbound IP resources of the cluster NAT gateway.

IdleTimeoutInMinutes: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes.

ManagedOutboundIPProfile: Profile of the managed outbound IP resources of the cluster NAT gateway.

Mode: Once the mode it set to Auto, it cannot be changed back to Manual.

"Auto"

"Manual"

"Auto"

"Manual"

Mode: Once the mode it set to Auto, it cannot be changed back to Manual.

RestrictionLevel: The restriction level applied to the cluster’s node resource group

"ReadOnly"

"Unrestricted"

"ReadOnly"

"Unrestricted"

RestrictionLevel: The restriction level applied to the cluster’s node resource group

Enabled: Whether the OIDC issuer is enabled.

Enabled: Whether the OIDC issuer is enabled.

IssuerURL: The OIDC issuer url of the Managed Cluster.

OIDCIssuerProfile: indicates where the OIDCIssuerProfile config map should be placed. If omitted, no config map will be created.

AdminCredentials: indicates where the AdminCredentials secret should be placed. If omitted, the secret will not be retrieved from Azure.

UserCredentials: indicates where the UserCredentials secret should be placed. If omitted, the secret will not be retrieved from Azure.

ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).

ConfigMaps: configures where to place operator written ConfigMaps.

SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

Secrets: configures where to place Azure generated secrets.

BindingSelector: The binding selector to use for the AzureIdentityBinding resource.

Identity: The user assigned identity details.

Name: The name of the pod identity.

Namespace: The namespace of the pod identity.

Name: The name of the pod identity exception.

Namespace: The namespace of the pod identity exception.

PodLabels: The pod labels to match.

Name: The name of the pod identity exception.

Namespace: The namespace of the pod identity exception.

PodLabels: The pod labels to match.

AllowNetworkPluginKubenet: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See using Kubenet network plugin with AAD Pod Identity for more information.

Enabled: Whether the pod identity addon is enabled.

UserAssignedIdentities: The pod identities to use in the cluster.

UserAssignedIdentityExceptions: The pod identity exceptions to allow.

AllowNetworkPluginKubenet: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See using Kubenet network plugin with AAD Pod Identity for more information.

Enabled: Whether the pod identity addon is enabled.

UserAssignedIdentities: The pod identities to use in the cluster.

UserAssignedIdentityExceptions: The pod identity exceptions to allow.

Code: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

Details: A list of additional details about the error.

Message: A message describing the error, intended to be suitable for display in a user interface.

Target: The target of the particular error. For example, the name of the property in error.

Code: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

Message: A message describing the error, intended to be suitable for display in a user interface.

Target: The target of the particular error. For example, the name of the property in error.

Error: Details about the error.

Error: Pod identity assignment error (if any).

"Assigned"

"Canceled"

"Deleting"

"Failed"

"Succeeded"

"Updating"

BindingSelector: The binding selector to use for the AzureIdentityBinding resource.

Identity: The user assigned identity details.

Name: The name of the pod identity.

Namespace: The namespace of the pod identity.

ProvisioningState: The current provisioning state of the pod identity.

BalanceSimilarNodeGroups: Valid values are ‘true’ and ‘false’

DaemonsetEvictionForEmptyNodes: If set to true, all daemonset pods on empty nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted.

DaemonsetEvictionForOccupiedNodes: If set to true, all daemonset pods on occupied nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted.

Expander: Available values are: ‘least-waste’, ‘most-pods’, ‘priority’, ‘random’.

IgnoreDaemonsetsUtilization: If set to true, the resources used by daemonset will be taken into account when making scaling down decisions.

MaxEmptyBulkDelete: The default is 10.

MaxGracefulTerminationSec: The default is 600.

MaxNodeProvisionTime: The default is ‘15m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

MaxTotalUnreadyPercentage: The default is 45. The maximum is 100 and the minimum is 0.

NewPodScaleUpDelay: For scenarios like burst/batch scale where you don’t want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they’re a certain age. The default is ‘0s’. Values must be an integer followed by a unit (’s’ for seconds, ’m’ for minutes, ‘h’ for hours, etc).

OkTotalUnreadyCount: This must be an integer. The default is 3.

ScaleDownDelayAfterAdd: The default is ‘10m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

ScaleDownDelayAfterDelete: The default is the scan-interval. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

ScaleDownDelayAfterFailure: The default is ‘3m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

ScaleDownUnneededTime: The default is ‘10m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

ScaleDownUnreadyTime: The default is ‘20m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

ScaleDownUtilizationThreshold: The default is ‘0.5’.

ScanInterval: The default is ‘10’. Values must be an integer number of seconds.

SkipNodesWithLocalStorage: The default is true.

SkipNodesWithSystemPods: The default is true.

BalanceSimilarNodeGroups: Valid values are ‘true’ and ‘false’

DaemonsetEvictionForEmptyNodes: If set to true, all daemonset pods on empty nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted.

DaemonsetEvictionForOccupiedNodes: If set to true, all daemonset pods on occupied nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted.

Expander: Available values are: ‘least-waste’, ‘most-pods’, ‘priority’, ‘random’.

IgnoreDaemonsetsUtilization: If set to true, the resources used by daemonset will be taken into account when making scaling down decisions.

MaxEmptyBulkDelete: The default is 10.

MaxGracefulTerminationSec: The default is 600.

MaxNodeProvisionTime: The default is ‘15m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

MaxTotalUnreadyPercentage: The default is 45. The maximum is 100 and the minimum is 0.

NewPodScaleUpDelay: For scenarios like burst/batch scale where you don’t want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they’re a certain age. The default is ‘0s’. Values must be an integer followed by a unit (’s’ for seconds, ’m’ for minutes, ‘h’ for hours, etc).

OkTotalUnreadyCount: This must be an integer. The default is 3.

ScaleDownDelayAfterAdd: The default is ‘10m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

ScaleDownDelayAfterDelete: The default is the scan-interval. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

ScaleDownDelayAfterFailure: The default is ‘3m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

ScaleDownUnneededTime: The default is ‘10m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

ScaleDownUnreadyTime: The default is ‘20m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

ScaleDownUtilizationThreshold: The default is ‘0.5’.

ScanInterval: The default is ‘10’. Values must be an integer number of seconds.

SkipNodesWithLocalStorage: The default is true.

SkipNodesWithSystemPods: The default is true.

"Disabled"

"Enabled"

"SecuredByPerimeter"

"Disabled"

"Enabled"

"SecuredByPerimeter"

Name: The name of a managed cluster SKU.

Tier: If not specified, the default is ‘Free’. See AKS Pricing Tier for more details.

"Automatic"

"Base"

"Automatic"

"Base"

Name: The name of a managed cluster SKU.

Tier: If not specified, the default is ‘Free’. See AKS Pricing Tier for more details.

"Free"

"Premium"

"Standard"

"Free"

"Premium"

"Standard"

AzureKeyVaultKms: Azure Key Vault key management service settings for the security profile.

CustomCATrustCertificates: A list of up to 10 base64 encoded CAs that will be added to the trust store on nodes with the Custom CA Trust feature enabled. For more information see Custom CA Trust Certificates

Defender: Microsoft Defender settings for the security profile.

ImageCleaner: Image Cleaner settings for the security profile.

ImageIntegrity: Image integrity is a feature that works with Azure Policy to verify image integrity by signature. This will not have any effect unless Azure Policy is applied to enforce image signatures. See https://aka.ms/aks/image-integrity for how to use this feature via policy.

NodeRestriction: Node Restriction settings for the security profile.

WorkloadIdentity: Workload identity settings for the security profile. Workload identity enables Kubernetes applications to access Azure cloud resources securely with Azure AD. See https://aka.ms/aks/wi for more details.

LogAnalyticsWorkspaceResourceReference: Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty.

SecurityMonitoring: Microsoft Defender threat detection for Cloud settings for the security profile.

Enabled: Whether to enable Defender threat detection

Enabled: Whether to enable Defender threat detection

LogAnalyticsWorkspaceResourceId: Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty.

SecurityMonitoring: Microsoft Defender threat detection for Cloud settings for the security profile.

Enabled: Whether to enable Image Cleaner on AKS cluster.

IntervalHours: Image Cleaner scanning interval in hours.

Enabled: Whether to enable Image Cleaner on AKS cluster.

IntervalHours: Image Cleaner scanning interval in hours.

Enabled: Whether to enable image integrity. The default value is false.

Enabled: Whether to enable image integrity. The default value is false.

Enabled: Whether to enable Node Restriction

Enabled: Whether to enable Node Restriction

Enabled: Whether to enable workload identity.

Enabled: Whether to enable workload identity.

AzureKeyVaultKms: Azure Key Vault key management service settings for the security profile.

CustomCATrustCertificates: A list of up to 10 base64 encoded CAs that will be added to the trust store on nodes with the Custom CA Trust feature enabled. For more information see Custom CA Trust Certificates

Defender: Microsoft Defender settings for the security profile.

ImageCleaner: Image Cleaner settings for the security profile.

ImageIntegrity: Image integrity is a feature that works with Azure Policy to verify image integrity by signature. This will not have any effect unless Azure Policy is applied to enforce image signatures. See https://aka.ms/aks/image-integrity for how to use this feature via policy.

NodeRestriction: Node Restriction settings for the security profile.

WorkloadIdentity: Workload identity settings for the security profile. Workload identity enables Kubernetes applications to access Azure cloud resources securely with Azure AD. See https://aka.ms/aks/wi for more details.

ClientId: The ID for the service principal.

Secret: The secret password associated with the service principal in plain text.

ClientId: The ID for the service principal.

Enabled: Indicates if Static Egress Gateway addon is enabled or not.

Enabled: Indicates if Static Egress Gateway addon is enabled or not.

BlobCSIDriver: AzureBlob CSI Driver settings for the storage profile.

DiskCSIDriver: AzureDisk CSI Driver settings for the storage profile.

FileCSIDriver: AzureFile CSI Driver settings for the storage profile.

SnapshotController: Snapshot Controller settings for the storage profile.

Enabled: Whether to enable AzureBlob CSI Driver. The default value is false.