Managed Clusters - List Kubernetes Versions

參考

服務:: AKS

API 版本:: 2024-09-01

取得指定訂用帳戶中支援的 Kubernetes 版本清單。
包含版本的額外元數據，包括支援的修補程式版本、功能、可用的升級，以及版本預覽狀態的詳細數據

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

URI 參數

名稱	位於	必要	類型	Description
location	path	True	string	Azure 區域的名稱。
subscriptionId	path	True	string uuid	目標訂用帳戶的標識碼。此值必須是 UUID。
api-version	query	True	string	要用於這項作業的 API 版本。

回應

名稱	類型	Description
200 OK	KubernetesVersionListResult	還行
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

List Kubernetes Versions

範例要求

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

範例回覆

狀態碼:: 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": []
        }
      }
    }
  ]
}

定義

名稱	Description
CloudError	來自容器服務的錯誤回應。
CloudErrorBody	來自容器服務的錯誤回應。
KubernetesPatchVersion	Kubernetes 修補程式版本配置檔
KubernetesSupportPlan	AKS 受控叢集的不同支持層
KubernetesVersion	適用於指定 major.minor 版本的 Kubernetes 版本配置檔。
KubernetesVersionCapabilities	此 Kubernetes 版本的功能。
KubernetesVersionListResult	保留值屬性，這是 KubernetesVersion 的陣列

CloudError

來自容器服務的錯誤回應。

名稱	類型	Description
error	CloudErrorBody	錯誤的詳細數據。

CloudErrorBody

來自容器服務的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。程序代碼是不變的，而且是要以程序設計方式取用。
details	CloudErrorBody[]	錯誤的其他詳細數據清單。
message	string	描述錯誤的訊息，適用於在使用者介面中顯示。
target	string	特定錯誤的目標。例如，錯誤中的屬性名稱。

KubernetesPatchVersion

Kubernetes 修補程式版本配置檔

名稱	類型	Description
upgrades	string[]	指定修補程式版本的可能升級路徑

KubernetesSupportPlan

AKS 受控叢集的不同支持層

名稱	類型	Description
AKSLongTermSupport	string	超過 KubernetesOfficial 支援 1 年的版本支援。 AKS 繼續修補 CVE 再 1 年，總共支援 2 年。
KubernetesOfficial	string	版本支援與開放原始碼 Kubernetes 供應專案相同。正式 Kubernetes 開放原始碼社群在發行后 1 年支援版本。

KubernetesVersion

適用於指定 major.minor 版本的 Kubernetes 版本配置檔。

名稱	類型	Description
capabilities	KubernetesVersionCapabilities	此 Kubernetes 版本的功能。
isDefault	boolean	此版本是否為預設值。
isPreview	boolean	此版本是否處於預覽模式。
patchVersions	<string, KubernetesPatchVersion>	Kubernetes 版本的修補程式版本
version	string	kubernetes 版本的 major.minor 版本

KubernetesVersionCapabilities

此 Kubernetes 版本的功能。

名稱	類型	Description
supportPlan	KubernetesSupportPlan[]	AKS 受控叢集的不同支持層

KubernetesVersionListResult

保留值屬性，這是 KubernetesVersion 的陣列

名稱	類型	Description
values	KubernetesVersion[]	支援的 Kubernetes 版本的 AKS 陣列。

共用方式為

Managed Clusters - List Kubernetes Versions

URI 參數

回應

安全性

azure_auth

範圍

範例

List Kubernetes Versions

範例要求

範例回覆

定義

CloudError

CloudErrorBody

KubernetesPatchVersion

KubernetesSupportPlan

KubernetesVersion

KubernetesVersionCapabilities

KubernetesVersionListResult

其他資源