Managed Clusters - List Kubernetes Versions

Referenz

Dienst:: AKS

API-Version:: 2024-09-01

Ruft eine Liste der unterstützten Kubernetes-Versionen im angegebenen Abonnement ab.
Enthält zusätzliche Metadaten für die Version, einschließlich unterstützter Patchversionen, Funktionen, verfügbarer Upgrades und Details zum Vorschaustatus der Version.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
location	path	True	string	Der Name der Azure-Region.
subscriptionId	path	True	string uuid	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	KubernetesVersionListResult	OKAY
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

List Kubernetes Versions

Beispielanforderung

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


/**
 * Samples for ManagedClusters ListKubernetesVersions.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-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-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

Beispiel für eine Antwort

Statuscode:: 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": []
        }
      }
    }
  ]
}

Definitionen

Name	Beschreibung
CloudError	Eine Fehlerantwort des Containerdiensts.
CloudErrorBody	Eine Fehlerantwort des Containerdiensts.
KubernetesPatchVersion	Kubernetes Patchversionsprofil
KubernetesSupportPlan	Verschiedene Unterstützungsebenen für verwaltete AKS-Cluster
KubernetesVersion	Kubernetes-Versionsprofil für die angegebene Major.Minor-Version.
KubernetesVersionCapabilities	Funktionen für diese Kubernetes-Version.
KubernetesVersionListResult	Hold values properties, which is array of KubernetesVersion

CloudError

Eine Fehlerantwort des Containerdiensts.

Name	Typ	Beschreibung
error	CloudErrorBody	Details zum Fehler.

CloudErrorBody

Eine Fehlerantwort des Containerdiensts.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
target	string	Das Ziel des bestimmten Fehlers. Beispielsweise der Name der Eigenschaft im Fehler.

KubernetesPatchVersion

Kubernetes Patchversionsprofil

Name	Typ	Beschreibung
upgrades	string[]	Möglicher Upgradepfad für bestimmte Patchversion

KubernetesSupportPlan

Verschiedene Unterstützungsebenen für verwaltete AKS-Cluster

Name	Typ	Beschreibung
AKSLongTermSupport	string	Unterstützung für die Version, die über den KubernetesOfficial Support von 1 Jahr erweitert wurde. AKS setzt CVEs für weitere 1 Jahr fort, für insgesamt 2 Jahre Unterstützung.
KubernetesOfficial	string	Die Unterstützung für die Version ist identisch mit dem Open Source Kubernetes-Angebot. Offizielle Kubernetes Open Source Community-Supportversionen für 1 Jahr nach der Veröffentlichung.

KubernetesVersion

Kubernetes-Versionsprofil für die angegebene Major.Minor-Version.

Name	Typ	Beschreibung
capabilities	KubernetesVersionCapabilities	Funktionen für diese Kubernetes-Version.
isDefault	boolean	Gibt an, ob diese Version standardmäßig ist.
isPreview	boolean	Gibt an, ob sich diese Version im Vorschaumodus befindet.
patchVersions	<string, KubernetesPatchVersion>	Patchversionen der Kubernetes-Version
version	string	major.minor version of Kubernetes release

KubernetesVersionCapabilities

Funktionen für diese Kubernetes-Version.

Name	Typ	Beschreibung
supportPlan	KubernetesSupportPlan[]	Verschiedene Unterstützungsebenen für verwaltete AKS-Cluster

KubernetesVersionListResult

Hold values properties, which is array of KubernetesVersion

Name	Typ	Beschreibung
values	KubernetesVersion[]	Array von AKS unterstützte Kubernetes-Versionen.

Freigeben über

Managed Clusters - List Kubernetes Versions

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

List Kubernetes Versions

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CloudError

CloudErrorBody

KubernetesPatchVersion

KubernetesSupportPlan

KubernetesVersion

KubernetesVersionCapabilities

KubernetesVersionListResult

Zusätzliche Ressourcen