Agent Pools - Get Upgrade Profile

Serviço:: AKS

Versão da API:: 2026-06-01

Obtém o perfil de atualização de um pool de agentes.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
agentPoolName	path	True	string minLength: 1 maxLength: 12 pattern: ^[a-z][a-z0-9]{0,11}$	O nome do pool de agentes.
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)	O 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	AgentPoolUpgradeProfile	Operação do Azure concluída com sucesso.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory.

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

Escopos

Nome	Description
user_impersonation	se passar pela sua conta de usuário

Exemplos

Get Upgrade Profile 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/agentPools/agentpool1/upgradeProfiles/default?api-version=2026-06-01

Resposta de exemplo

Código de status:: 200

{
  "name": "default",
  "type": "Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/upgradeprofiles/default",
  "properties": {
    "kubernetesVersion": "1.12.8",
    "latestNodeImageVersion": "AKSUbuntu:1604:2020.03.11",
    "osType": "Linux",
    "upgrades": [
      {
        "kubernetesVersion": "1.13.5"
      }
    ]
  }
}

Definições

Nome	Description
AgentPoolRecentlyUsedVersion	Uma versão histórica que pode ser usada para operações de reversão.
AgentPoolUpgradeProfile	A lista de atualizações disponíveis para um pool de agentes.
AgentPoolUpgradeProfilePropertiesUpgradesItem	Upgrades disponíveis para um AgentPool.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
OSType	O tipo de sistema operacional. O padrão é Linux.
systemData	Metadados relativos à criação e última modificação do recurso.

AgentPoolRecentlyUsedVersion

Objeto

Uma versão histórica que pode ser usada para operações de reversão.

Nome	Tipo	Description
nodeImageVersion	string	A versão da imagem do nó disponível para reversão.
orchestratorVersion	string	A versão do Kubernetes (major.minor.patch) disponível para reversão.
timestamp	string (date-time)	O carimbo de data/hora em que esta versão foi usada pela última vez.

AgentPoolUpgradeProfile

Objeto

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

Nome	Tipo	Valor padrão	Description
id	string (arm-id)		ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string		O nome do recurso
properties.kubernetesVersion	string		A versão do Kubernetes (major.minor.patch).
properties.latestNodeImageVersion	string		A versão mais recente da imagem de nó com suporte do AKS.
properties.osType	OSType	Linux	O tipo de sistema operacional. O padrão é Linux.
properties.recentlyUsedVersions	AgentPoolRecentlyUsedVersion[]		Lista de versões válidas históricas para operações de reversão.
properties.upgrades	AgentPoolUpgradeProfilePropertiesUpgradesItem[]		Lista de tipos de orquestrador e versões disponíveis para atualização.
systemData	systemData		Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

AgentPoolUpgradeProfilePropertiesUpgradesItem

Objeto

Upgrades disponíveis para um AgentPool.

Nome	Tipo	Description
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).

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

Informações adicionais sobre o 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[]	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 alvo do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

OSType

Enumeração

O tipo de sistema operacional. O padrão é Linux.

Valor	Description
Linux	Use Linux.
Windows	Use o Windows.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O registro de data e hora da criação do recurso (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.