Managed Clusters - List Kubernetes Versions

Reference

Service:: AKS

API Version:: 2024-09-01

Gets a list of supported Kubernetes versions in the specified subscription.
Contains extra metadata on the version, including supported patch versions, capabilities, available upgrades, and details on preview status of the version

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/kubernetesVersions?api-version=2024-09-01

URI Parameters

Name	In	Required	Type	Description
location	path	True	string	The name of the Azure region.
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	KubernetesVersionListResult	OK
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

List Kubernetes Versions

Sample request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/kubernetesVersions?api-version=2024-09-01

from azure.identity import DefaultAzureCredential

from azure.mgmt.containerservice import ContainerServiceClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-containerservice
# USAGE
    python kubernetes_versions_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ContainerServiceClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.managed_clusters.list_kubernetes_versions(
        location="location1",
    )
    print(response)


# x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/KubernetesVersions_List.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcontainerservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/containerservice/armcontainerservice/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/KubernetesVersions_List.json
func ExampleManagedClustersClient_ListKubernetesVersions() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcontainerservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewManagedClustersClient().ListKubernetesVersions(ctx, "location1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.KubernetesVersionListResult = armcontainerservice.KubernetesVersionListResult{
	// 	Values: []*armcontainerservice.KubernetesVersion{
	// 		{
	// 			Capabilities: &armcontainerservice.KubernetesVersionCapabilities{
	// 				SupportPlan: []*armcontainerservice.KubernetesSupportPlan{
	// 					to.Ptr(armcontainerservice.KubernetesSupportPlanKubernetesOfficial)},
	// 				},
	// 				PatchVersions: map[string]*armcontainerservice.KubernetesPatchVersion{
	// 					"1.23.12": &armcontainerservice.KubernetesPatchVersion{
	// 						Upgrades: []*string{
	// 							to.Ptr("1.23.15"),
	// 							to.Ptr("1.24.6"),
	// 							to.Ptr("1.24.9")},
	// 						},
	// 						"1.23.15": &armcontainerservice.KubernetesPatchVersion{
	// 							Upgrades: []*string{
	// 								to.Ptr("1.24.6"),
	// 								to.Ptr("1.24.9")},
	// 							},
	// 						},
	// 						Version: to.Ptr("1.23"),
	// 					},
	// 					{
	// 						Capabilities: &armcontainerservice.KubernetesVersionCapabilities{
	// 							SupportPlan: []*armcontainerservice.KubernetesSupportPlan{
	// 								to.Ptr(armcontainerservice.KubernetesSupportPlanKubernetesOfficial)},
	// 							},
	// 							IsDefault: to.Ptr(true),
	// 							PatchVersions: map[string]*armcontainerservice.KubernetesPatchVersion{
	// 								"1.24.6": &armcontainerservice.KubernetesPatchVersion{
	// 									Upgrades: []*string{
	// 										to.Ptr("1.24.9"),
	// 										to.Ptr("1.25.4"),
	// 										to.Ptr("1.25.5")},
	// 									},
	// 									"1.24.9": &armcontainerservice.KubernetesPatchVersion{
	// 										Upgrades: []*string{
	// 											to.Ptr("1.25.4"),
	// 											to.Ptr("1.25.5")},
	// 										},
	// 									},
	// 									Version: to.Ptr("1.24"),
	// 								},
	// 								{
	// 									Capabilities: &armcontainerservice.KubernetesVersionCapabilities{
	// 										SupportPlan: []*armcontainerservice.KubernetesSupportPlan{
	// 											to.Ptr(armcontainerservice.KubernetesSupportPlanKubernetesOfficial)},
	// 										},
	// 										PatchVersions: map[string]*armcontainerservice.KubernetesPatchVersion{
	// 											"1.25.4": &armcontainerservice.KubernetesPatchVersion{
	// 												Upgrades: []*string{
	// 													to.Ptr("1.25.5"),
	// 													to.Ptr("1.26.0")},
	// 												},
	// 												"1.25.5": &armcontainerservice.KubernetesPatchVersion{
	// 													Upgrades: []*string{
	// 														to.Ptr("1.26.0")},
	// 													},
	// 												},
	// 												Version: to.Ptr("1.25"),
	// 											},
	// 											{
	// 												Capabilities: &armcontainerservice.KubernetesVersionCapabilities{
	// 													SupportPlan: []*armcontainerservice.KubernetesSupportPlan{
	// 														to.Ptr(armcontainerservice.KubernetesSupportPlanKubernetesOfficial)},
	// 													},
	// 													IsPreview: to.Ptr(true),
	// 													PatchVersions: map[string]*armcontainerservice.KubernetesPatchVersion{
	// 														"1.26.0": &armcontainerservice.KubernetesPatchVersion{
	// 															Upgrades: []*string{
	// 															},
	// 														},
	// 													},
	// 													Version: to.Ptr("1.26"),
	// 											}},
	// 										}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ContainerServiceClient } = require("@azure/arm-containerservice");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Contains extra metadata on the version, including supported patch versions, capabilities, available upgrades, and details on preview status of the version
 *
 * @summary Contains extra metadata on the version, including supported patch versions, capabilities, available upgrades, and details on preview status of the version
 * x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/KubernetesVersions_List.json
 */
async function listKubernetesVersions() {
  const subscriptionId =
    process.env["CONTAINERSERVICE_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const location = "location1";
  const credential = new DefaultAzureCredential();
  const client = new ContainerServiceClient(credential, subscriptionId);
  const result = await client.managedClusters.listKubernetesVersions(location);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "values": [
    {
      "version": "1.23",
      "capabilities": {
        "supportPlan": [
          "KubernetesOfficial"
        ]
      },
      "patchVersions": {
        "1.23.12": {
          "upgrades": [
            "1.23.15",
            "1.24.6",
            "1.24.9"
          ]
        },
        "1.23.15": {
          "upgrades": [
            "1.24.6",
            "1.24.9"
          ]
        }
      }
    },
    {
      "version": "1.24",
      "isDefault": true,
      "capabilities": {
        "supportPlan": [
          "KubernetesOfficial"
        ]
      },
      "patchVersions": {
        "1.24.6": {
          "upgrades": [
            "1.24.9",
            "1.25.4",
            "1.25.5"
          ]
        },
        "1.24.9": {
          "upgrades": [
            "1.25.4",
            "1.25.5"
          ]
        }
      }
    },
    {
      "version": "1.25",
      "capabilities": {
        "supportPlan": [
          "KubernetesOfficial"
        ]
      },
      "patchVersions": {
        "1.25.4": {
          "upgrades": [
            "1.25.5",
            "1.26.0"
          ]
        },
        "1.25.5": {
          "upgrades": [
            "1.26.0"
          ]
        }
      }
    },
    {
      "version": "1.26",
      "isPreview": true,
      "capabilities": {
        "supportPlan": [
          "KubernetesOfficial"
        ]
      },
      "patchVersions": {
        "1.26.0": {
          "upgrades": []
        }
      }
    }
  ]
}

Definitions

Name	Description
CloudError	An error response from the Container service.
CloudErrorBody	An error response from the Container service.
KubernetesPatchVersion	Kubernetes patch version profile
KubernetesSupportPlan	Different support tiers for AKS managed clusters
KubernetesVersion	Kubernetes version profile for given major.minor release.
KubernetesVersionCapabilities	Capabilities on this Kubernetes version.
KubernetesVersionListResult	Hold values properties, which is array of KubernetesVersion

CloudError

An error response from the Container service.

Name	Type	Description
error	CloudErrorBody	Details about the error.

CloudErrorBody

An error response from the Container service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

KubernetesPatchVersion

Kubernetes patch version profile

Name	Type	Description
upgrades	string[]	Possible upgrade path for given patch version

KubernetesSupportPlan

Different support tiers for AKS managed clusters

Name	Type	Description
AKSLongTermSupport	string	Support for the version extended past the KubernetesOfficial support of 1 year. AKS continues to patch CVEs for another 1 year, for a total of 2 years of support.
KubernetesOfficial	string	Support for the version is the same as for the open source Kubernetes offering. Official Kubernetes open source community support versions for 1 year after release.

KubernetesVersion

Kubernetes version profile for given major.minor release.

Name	Type	Description
capabilities	KubernetesVersionCapabilities	Capabilities on this Kubernetes version.
isDefault	boolean	Whether this version is default.
isPreview	boolean	Whether this version is in preview mode.
patchVersions	<string, KubernetesPatchVersion>	Patch versions of Kubernetes release
version	string	major.minor version of Kubernetes release

KubernetesVersionCapabilities

Capabilities on this Kubernetes version.

Name	Type	Description
supportPlan	KubernetesSupportPlan[]	Different support tiers for AKS managed clusters

KubernetesVersionListResult

Hold values properties, which is array of KubernetesVersion

Name	Type	Description
values	KubernetesVersion[]	Array of AKS supported Kubernetes versions.

Share via

Managed Clusters - List Kubernetes Versions

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

List Kubernetes Versions

Sample request

Sample response

Definitions

CloudError

CloudErrorBody

KubernetesPatchVersion

KubernetesSupportPlan

KubernetesVersion

KubernetesVersionCapabilities

KubernetesVersionListResult

Additional resources