Agent Pools - Get Available Agent Pool Versions

服務:: AKS

API 版本:: 2026-01-01

取得指定代理程式集區支援的 Kubernetes 版本清單。
如需版本生命週期的詳細資訊，請參閱支援的 Kubernetes 版本。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/availableAgentPoolVersions?api-version=2026-01-01

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。名稱不區分大小寫。
resourceName	path	True	string minLength: 1 maxLength: 63 pattern: ^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$	受管理叢集資源的名稱。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。此值必須是 UUID。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

回應

名稱	類型	Description
200 OK	AgentPoolAvailableVersions	Azure 運作順利完成。
Other Status Codes	ErrorResponse	未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow.

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

範圍

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

範例

Get available versions for agent pool

範例要求

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/availableAgentPoolVersions?api-version=2026-01-01


/**
 * Samples for AgentPools GetAvailableAgentPoolVersions.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-01-01/AgentPoolsGetAgentPoolAvailableVersions.json
     */
    /**
     * Sample code: Get available versions for agent pool.
     * 
     * @param manager Entry point to ContainerServiceManager.
     */
    public static void
        getAvailableVersionsForAgentPool(com.azure.resourcemanager.containerservice.ContainerServiceManager manager) {
        manager.serviceClient().getAgentPools().getAvailableAgentPoolVersionsWithResponse("rg1", "clustername1",
            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 agent_pools_get_agent_pool_available_versions.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="SUBSCRIPTION_ID",
    )

    response = client.agent_pools.get_available_agent_pool_versions(
        resource_group_name="rg1",
        resource_name="clustername1",
    )
    print(response)


# x-ms-original-file: 2026-01-01/AgentPoolsGetAgentPoolAvailableVersions.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/v9"
)

// Generated from example definition: 2026-01-01/AgentPoolsGetAgentPoolAvailableVersions.json
func ExampleAgentPoolsClient_GetAvailableAgentPoolVersions() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcontainerservice.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAgentPoolsClient().GetAvailableAgentPoolVersions(ctx, "rg1", "clustername1", 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 = armcontainerservice.AgentPoolsClientGetAvailableAgentPoolVersionsResponse{
	// 	AgentPoolAvailableVersions: &armcontainerservice.AgentPoolAvailableVersions{
	// 		Name: to.Ptr("default"),
	// 		Type: to.Ptr("Microsoft.ContainerService/managedClusters/availableAgentpoolVersions"),
	// 		ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/availableagentpoolversions"),
	// 		Properties: &armcontainerservice.AgentPoolAvailableVersionsProperties{
	// 			AgentPoolVersions: []*armcontainerservice.AgentPoolAvailableVersionsPropertiesAgentPoolVersionsItem{
	// 				{
	// 					KubernetesVersion: to.Ptr("1.12.7"),
	// 				},
	// 				{
	// 					KubernetesVersion: to.Ptr("1.12.8"),
	// 				},
	// 				{
	// 					Default: to.Ptr(true),
	// 					IsPreview: to.Ptr(true),
	// 					KubernetesVersion: to.Ptr("1.13.5"),
	// 				},
	// 			},
	// 		},
	// 	},
	// }
}

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 see [supported Kubernetes versions](https://docs.microsoft.com/azure/aks/supported-kubernetes-versions) for more details about the version lifecycle.
 *
 * @summary see [supported Kubernetes versions](https://docs.microsoft.com/azure/aks/supported-kubernetes-versions) for more details about the version lifecycle.
 * x-ms-original-file: 2026-01-01/AgentPoolsGetAgentPoolAvailableVersions.json
 */
async function getAvailableVersionsForAgentPool() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new ContainerServiceClient(credential, subscriptionId);
  const result = await client.agentPools.getAvailableAgentPoolVersions("rg1", "clustername1");
  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

{
  "name": "default",
  "type": "Microsoft.ContainerService/managedClusters/availableAgentpoolVersions",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/availableagentpoolversions",
  "properties": {
    "agentPoolVersions": [
      {
        "kubernetesVersion": "1.12.7"
      },
      {
        "kubernetesVersion": "1.12.8"
      },
      {
        "default": true,
        "isPreview": true,
        "kubernetesVersion": "1.13.5"
      }
    ]
  }
}

定義

名稱	Description
AgentPoolAvailableVersions	代理程式集區的可用版本清單。
AgentPoolAvailableVersionsPropertiesAgentPoolVersionsItem	代理池的可用版本資訊。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應

AgentPoolAvailableVersions

Object

代理程式集區的可用版本清單。

名稱	類型	Description
id	string	代理程式集區版本清單的識別碼。
name	string	代理程式集區版本清單的名稱。
properties.agentPoolVersions	AgentPoolAvailableVersionsPropertiesAgentPoolVersionsItem[]	代理程式集區可用的版本清單。
type	string	代理程式集區版本清單的類型。

AgentPoolAvailableVersionsPropertiesAgentPoolVersionsItem

Object

代理池的可用版本資訊。

名稱	類型	Description
default	boolean	此版本是否為預設代理程式集區版本。
isPreview	boolean	Kubernetes 版本目前是否處於預覽狀態。
kubernetesVersion	string	Kubernetes 版本（major.minor.patch）。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳情
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

共用方式為

Agent Pools - Get Available Agent Pool Versions

URI 參數

回應

安全性

azure_auth

範圍

範例

Get available versions for agent pool

範例要求

範例回覆

定義

AgentPoolAvailableVersions

AgentPoolAvailableVersionsPropertiesAgentPoolVersionsItem

ErrorAdditionalInfo

ErrorDetail

ErrorResponse