Managed Clusters - List Kubernetes Versions

Odwołanie

Usługa:: AKS

Wersja interfejsu API:: 2024-09-01

Pobiera listę obsługiwanych wersji platformy Kubernetes w określonej subskrypcji.
Zawiera dodatkowe metadane dotyczące wersji, w tym obsługiwane wersje poprawek, możliwości, dostępne uaktualnienia i szczegółowe informacje na temat stanu wersji zapoznawczej wersji

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
location	path	True	string	Nazwa regionu świadczenia usługi Azure.
subscriptionId	path	True	string uuid	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	KubernetesVersionListResult	OK
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

List Kubernetes Versions

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa	Opis
CloudError	Odpowiedź na błąd z usługi Container Service.
CloudErrorBody	Odpowiedź na błąd z usługi Container Service.
KubernetesPatchVersion	Profil wersji poprawki platformy Kubernetes
KubernetesSupportPlan	Różne warstwy pomocy technicznej dla klastrów zarządzanych usługi AKS
KubernetesVersion	Profil wersji platformy Kubernetes dla danej wersji głównej.pomocniczej.
KubernetesVersionCapabilities	Możliwości w tej wersji platformy Kubernetes.
KubernetesVersionListResult	Właściwości blokady wartości, które są tablicą kubernetesVersion

CloudError

Odpowiedź na błąd z usługi Container Service.

Nazwa	Typ	Opis
error	CloudErrorBody	Szczegółowe informacje o błędzie.

CloudErrorBody

Odpowiedź na błąd z usługi Container Service.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
details	CloudErrorBody[]	Lista dodatkowych szczegółów dotyczących błędu.
message	string	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
target	string	Element docelowy określonego błędu. Na przykład nazwa właściwości w błędzie.

KubernetesPatchVersion

Profil wersji poprawki platformy Kubernetes

Nazwa	Typ	Opis
upgrades	string[]	Możliwa ścieżka uaktualnienia dla danej wersji poprawki

KubernetesSupportPlan

Różne warstwy pomocy technicznej dla klastrów zarządzanych usługi AKS

Nazwa	Typ	Opis
AKSLongTermSupport	string	Obsługa wersji rozszerzonej w przeszłości wsparcia platformy KubernetesOfficial przez 1 rok. Usługa AKS nadal poprawia CVEs przez kolejny 1 rok, przez łącznie 2 lata wsparcia.
KubernetesOfficial	string	Obsługa wersji jest taka sama jak w przypadku oferty kubernetes typu open source. Oficjalne wersje pomocy technicznej społeczności open source platformy Kubernetes przez 1 rok po wydaniu.

KubernetesVersion

Profil wersji platformy Kubernetes dla danej wersji głównej.pomocniczej.

Nazwa	Typ	Opis
capabilities	KubernetesVersionCapabilities	Możliwości w tej wersji platformy Kubernetes.
isDefault	boolean	Czy ta wersja jest domyślna.
isPreview	boolean	Czy ta wersja jest w trybie podglądu.
patchVersions	<string, KubernetesPatchVersion>	Wersje poprawek wydania rozwiązania Kubernetes
version	string	wersja główna.pomocnicza wydania rozwiązania Kubernetes

KubernetesVersionCapabilities

Możliwości w tej wersji platformy Kubernetes.

Nazwa	Typ	Opis
supportPlan	KubernetesSupportPlan[]	Różne warstwy pomocy technicznej dla klastrów zarządzanych usługi AKS

KubernetesVersionListResult

Właściwości blokady wartości, które są tablicą kubernetesVersion

Nazwa	Typ	Opis
values	KubernetesVersion[]	Tablica obsługiwanych wersji platformy Kubernetes w usłudze AKS.

Udostępnij za pośrednictwem

Managed Clusters - List Kubernetes Versions

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

List Kubernetes Versions

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

CloudError

CloudErrorBody

KubernetesPatchVersion

KubernetesSupportPlan

KubernetesVersion

KubernetesVersionCapabilities

KubernetesVersionListResult

Dodatkowe zasoby