Managed Clusters - List Kubernetes Versions

Référence

Service:: AKS

API Version:: 2024-02-01

Obtient la liste des versions de Kubernetes prises en charge dans l’abonnement spécifié.
Contient des métadonnées supplémentaires sur la version, notamment les versions correctives prises en charge, les fonctionnalités, les mises à niveau disponibles et les détails sur la préversion status de la version

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
location	path	True	string	Nom de la région Azure.
subscriptionId	path	True	string uuid	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	KubernetesVersionListResult	Ok
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

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-02-01


/**
 * Samples for ManagedClusters ListKubernetesVersions.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-02-01/examples/
     * KubernetesVersions_List.json
     */
    /**
     * Sample code: List Kubernetes Versions.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listKubernetesVersions(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.kubernetesClusters().manager().serviceClient().getManagedClusters()
            .listKubernetesVersionsWithResponse("location1", com.azure.core.util.Context.NONE);
    }
}

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

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-02-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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-02-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-02-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": []
        }
      }
    }
  ]
}

Définitions

Nom	Description
CloudError	Réponse d’erreur du service conteneur.
CloudErrorBody	Réponse d’erreur du service conteneur.
KubernetesPatchVersion	Profil de version de correctif Kubernetes
KubernetesSupportPlan	Différents niveaux de support pour les clusters managés AKS
KubernetesVersion	Profil de version Kubernetes pour une version major.minor donnée.
KubernetesVersionCapabilities	Fonctionnalités sur cette version de Kubernetes.
KubernetesVersionListResult	Conserver les propriétés des valeurs, qui sont un tableau de KubernetesVersion

CloudError

Réponse d’erreur du service conteneur.

Nom	Type	Description
error	CloudErrorBody	Détails sur l’erreur.

CloudErrorBody

Réponse d’erreur du service conteneur.

Nom	Type	Description
code	string	Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.
details	CloudErrorBody[]	Liste de détails supplémentaires sur l’erreur.
message	string	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
target	string	Cible de l’erreur particulière. Par exemple, le nom de la propriété en erreur.

KubernetesPatchVersion

Profil de version de correctif Kubernetes

Nom	Type	Description
upgrades	string[]	Chemin de mise à niveau possible pour une version de correctif donnée

KubernetesSupportPlan

Différents niveaux de support pour les clusters managés AKS

Nom	Type	Description
AKSLongTermSupport	string	Prise en charge de la version étendue au-delà du support KubernetesOfficial de 1 an. AKS continue de corriger les CVC pendant 1 an, pour un total de 2 ans de support.
KubernetesOfficial	string	La prise en charge de la version est la même que pour l’offre Kubernetes open source. Les versions officielles de prise en charge de Kubernetes open source communauté pendant 1 an après la publication.

KubernetesVersion

Profil de version Kubernetes pour une version major.minor donnée.

Nom	Type	Description
capabilities	KubernetesVersionCapabilities	Fonctionnalités sur cette version de Kubernetes.
isDefault	boolean	Indique si cette version est par défaut.
isPreview	boolean	Indique si cette version est en mode préversion.
patchVersions	<string, KubernetesPatchVersion>	Versions correctives de la version de Kubernetes
version	string	version major.minor de Kubernetes

KubernetesVersionCapabilities

Fonctionnalités sur cette version de Kubernetes.

Nom	Type	Description
supportPlan	KubernetesSupportPlan[]	Différents niveaux de support pour les clusters managés AKS

KubernetesVersionListResult

Conserver les propriétés des valeurs, qui sont un tableau de KubernetesVersion

Nom	Type	Description
values	KubernetesVersion[]	Tableau de versions de Kubernetes prises en charge par AKS.

Managed Clusters - List Kubernetes Versions

Paramètres URI

Réponses

Sécurité

azure_auth

Scopes

Exemples

List Kubernetes Versions

Sample Request

Sample Response

Définitions

CloudError

CloudErrorBody

KubernetesPatchVersion

KubernetesSupportPlan

KubernetesVersion

KubernetesVersionCapabilities

KubernetesVersionListResult

Ressources supplémentaires