OSSku Class

public final class OSSku
extends ExpandableStringEnum<OSSku>

Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows.

Field Summary

Modifier and Type Field and Description
static final OSSku AZURE_LINUX

Use AzureLinux as the OS for node images.

static final OSSku AZURE_LINUX3

Use AzureLinux3 as the OS for node images.

static final OSSku CBLMARINER

Deprecated OSSKU.

static final OSSku FLATCAR

Use Flatcar Container Linux as the OS for node images.

static final OSSku MARINER

Deprecated OSSKU.

static final OSSku UBUNTU

Use Ubuntu as the OS for node images.

static final OSSku UBUNTU2204

Use Ubuntu2204 as the OS for node images, however, Ubuntu 22.04 may not be supported for all nodepools.

static final OSSku UBUNTU2404

Use Ubuntu2404 as the OS for node images, however, Ubuntu 24.04 may not be supported for all nodepools.

static final OSSku WINDOWS2019

Use Windows2019 as the OS for node images.

static final OSSku WINDOWS2022

Use Windows2022 as the OS for node images.

static final OSSku WINDOWS2025

Use Windows2025 as the OS for node images.

static final OSSku WINDOWS_ANNUAL

Use Windows Annual Channel version as the OS for node images.

Constructor Summary

Constructor Description
OSSku()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of OSSku value.

Method Summary

Modifier and Type Method and Description
static OSSku fromString(String name)

Creates or finds a OSSku from its string representation.

static Collection<OSSku> values()

Gets known OSSku values.

Methods inherited from ExpandableStringEnum

Methods inherited from java.lang.Object

Field Details

AZURE_LINUX

public static final OSSku AZURE_LINUX

Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information.

AZURE_LINUX3

public static final OSSku AZURE_LINUX3

Use AzureLinux3 as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information. For limitations, visit https://aka.ms/aks/node-images. For OS migration guidance, see https://aka.ms/aks/upgrade-os-version.

CBLMARINER

public static final OSSku CBLMARINER

Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead.

FLATCAR

public static final OSSku FLATCAR

Use Flatcar Container Linux as the OS for node images. Flatcar is a container-optimized, security-focused Linux OS, with an immutable filesystem and part of the Cloud Native Computing Foundation (CNCF). For more information about Flatcar Container Linux for AKS, see aka.ms/aks/flatcar-container-linux-for-aks.

MARINER

public static final OSSku MARINER

Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead.

UBUNTU

public static final OSSku UBUNTU

Use Ubuntu as the OS for node images.

UBUNTU2204

public static final OSSku UBUNTU2204

Use Ubuntu2204 as the OS for node images, however, Ubuntu 22.04 may not be supported for all nodepools. For limitations and supported kubernetes versions, see https://aka.ms/aks/supported-ubuntu-versions.

UBUNTU2404

public static final OSSku UBUNTU2404

Use Ubuntu2404 as the OS for node images, however, Ubuntu 24.04 may not be supported for all nodepools. For limitations and supported kubernetes versions, see see https://aka.ms/aks/supported-ubuntu-versions.

WINDOWS2019

public static final OSSku WINDOWS2019

Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa.

WINDOWS2022

public static final OSSku WINDOWS2022

Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa.

WINDOWS2025

public static final OSSku WINDOWS2025

Use Windows2025 as the OS for node images. Unsupported for system node pools. Windows2025 supports Windows2022 and Windows 2025 containers; it cannot run Windows2019 containers and vice versa.

WINDOWS_ANNUAL

public static final OSSku WINDOWS_ANNUAL

Use Windows Annual Channel version as the OS for node images. Unsupported for system node pools. Details about supported container images and kubernetes versions under different AKS Annual Channel versions could be seen in https://aka.ms/aks/windows-annual-channel-details.

Constructor Details

OSSku

@Deprecated
public OSSku()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of OSSku value.

Method Details

fromString

public static OSSku fromString(String name)

Creates or finds a OSSku from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding OSSku.

values

public static Collection<OSSku> values()

Gets known OSSku values.

Returns:

known OSSku values.

Applies to