Agent Pools - Get Upgrade Profile

Reference

Service:: AKS

API Version:: 2024-02-01

Gets the upgrade profile for an agent pool.

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

URI Parameters

Name	In	Required	Type	Description
agentPoolName	path	True	string	The name of the agent pool. Regex pattern: `^[a-z][a-z0-9]{0,11}$`
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
resourceName	path	True	string	The name of the managed cluster resource. Regex pattern: `^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$`
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	AgentPoolUpgradeProfile	OK
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get Upgrade Profile for Agent Pool

Sample Request

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=2024-02-01

Sample Response

Status code:: 200

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

Definitions

Name	Description
AgentPoolUpgradeProfile	The list of available upgrades for an agent pool.
CloudError	An error response from the Container service.
CloudErrorBody	An error response from the Container service.
OSType	The operating system type. The default is Linux.
Upgrades	List of orchestrator types and versions available for upgrade.

AgentPoolUpgradeProfile

The list of available upgrades for an agent pool.

Name	Type	Default Value	Description
id	string		The ID of the agent pool upgrade profile.
name	string		The name of the agent pool upgrade profile.
properties.kubernetesVersion	string		The Kubernetes version (major.minor.patch).
properties.latestNodeImageVersion	string		The latest AKS supported node image version.
properties.osType	OSType	Linux	The operating system type. The default is Linux.
properties.upgrades	Upgrades[]		List of orchestrator types and versions available for upgrade.
type	string		The type of the agent pool upgrade profile.

CloudError

An error response from the Container service.

Name	Type	Description
error	CloudErrorBody	Details about the error.

CloudErrorBody