Agent Pools - Get Available Agent Pool Versions

Dienst:

AKS

API-Version:

2026-01-01

Ruft eine Liste der unterstützten Kubernetes-Versionen für den angegebenen Agent-Pool ab.
Weitere Informationen zum Versionslebenszyklus finden Sie unter unterstützten Kubernetes-Versionen.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
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]$	Der Name der verwalteten Clusterressource.
subscriptionId	path	True	string (uuid)	Hierbei handelt es sich um die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	AgentPoolAvailableVersions	Azure-Operation erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Get available versions for agent pool

Beispielanforderung

HTTP

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

Java

/**
 * 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

Python

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

Go

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

JavaScript

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

Beispiel für eine Antwort

Statuscode:

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"
      }
    ]
  }
}

Definitionen

Name	Beschreibung
AgentPoolAvailableVersions	Die Liste der verfügbaren Versionen für einen Agentpool.
AgentPoolAvailableVersionsPropertiesAgentPoolVersionsItem	Verfügbare Versionsinformationen für einen Agentenpool.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort

AgentPoolAvailableVersions

Objekt

Die Liste der verfügbaren Versionen für einen Agentpool.

Name	Typ	Beschreibung
id	string	Die ID der Versionsliste des Agentpools.
name	string	Der Name der Versionsliste des Agent-Pools.
properties.agentPoolVersions	AgentPoolAvailableVersionsPropertiesAgentPoolVersionsItem[]	Liste der Versionen, die für den Agent-Pool verfügbar sind.
type	string	Typ der Versionsliste des Agentpools.

AgentPoolAvailableVersionsPropertiesAgentPoolVersionsItem

Objekt

Verfügbare Versionsinformationen für einen Agentenpool.

Name	Typ	Beschreibung
default	boolean	Gibt an, ob es sich bei dieser Version um die Standardversion des Agentpools handelt.
isPreview	boolean	Gibt an, ob sich die Kubernetes-Version derzeit in der Vorschau befindet.
kubernetesVersion	string	Die Kubernetes-Version (major.minor.patch).

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.