Agent Pools - Get Available Agent Pool Versions

Serviço:

AKS

Versão da API:

2026-01-01

Obtém uma lista de versões do Kubernetes com suporte para o pool de agentes especificado.
Consulte versões do Kubernetes com suporte para obter mais detalhes sobre o ciclo de vida da versão.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
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]$	O nome do recurso de cluster gerenciado.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	AgentPoolAvailableVersions	Operação do Azure concluída com sucesso.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Get available versions for agent pool

Solicitação de exemplo

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

Resposta de exemplo

Código de status:

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

Definições

Nome	Description
AgentPoolAvailableVersions	A lista de versões disponíveis para um pool de agentes.
AgentPoolAvailableVersionsPropertiesAgentPoolVersionsItem	Informações disponíveis sobre a versão de um pool de agentes.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro

AgentPoolAvailableVersions

Objeto

A lista de versões disponíveis para um pool de agentes.

Nome	Tipo	Description
id	string	A ID da lista de versões do pool de agentes.
name	string	O nome da lista de versões do pool de agentes.
properties.agentPoolVersions	AgentPoolAvailableVersionsPropertiesAgentPoolVersionsItem[]	Lista de versões disponíveis para o pool de agentes.
type	string	Tipo da lista de versões do pool de agentes.

AgentPoolAvailableVersionsPropertiesAgentPoolVersionsItem

Objeto

Informações disponíveis sobre a versão de um pool de agentes.

Nome	Tipo	Description
default	boolean	Se esta versão é a versão padrão do pool de agentes.
isPreview	boolean	Se a versão do Kubernetes está atualmente em versão prévia.
kubernetesVersion	string	A versão do Kubernetes (major.minor.patch).

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.