Managed Clusters - Get Upgrade Profile

Service:

AKS

API Version:

2020-03-01

Gets upgrade profile for a managed cluster.
Gets the details of the upgrade profile for a managed cluster with a specified resource group and name.

HTTP

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

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group.
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	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client Api Version.

Responses

Name	Type	Description
200 OK	ManagedClusterUpgradeProfile	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 Managed Cluster

Sample request

HTTP

HTTP

GET https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/upgradeProfiles/default?api-version=2020-03-01

Sample response

Status code:

200

JSON

{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/upgradeprofiles/default",
  "name": "default",
  "properties": {
    "agentPoolProfiles": [
      {
        "kubernetesVersion": "1.7.7",
        "name": "agent",
        "osType": "Linux",
        "upgrades": [
          {
            "kubernetesVersion": "1.7.9"
          },
          {
            "kubernetesVersion": "1.7.11",
            "isPreview": true
          }
        ]
      }
    ],
    "controlPlaneProfile": {
      "kubernetesVersion": "1.7.7",
      "name": "master",
      "osType": "Linux",
      "upgrades": [
        {
          "kubernetesVersion": "1.7.9",
          "isPreview": true
        },
        {
          "kubernetesVersion": "1.7.11"
        }
      ]
    }
  },
  "type": "Microsoft.ContainerService/managedClusters/upgradeprofiles"
}

Definitions

Name	Description
CloudError	An error response from the Container service.
CloudErrorBody	An error response from the Container service.
ContainerServiceOSTypes	OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux.
ManagedClusterPoolUpgradeProfile	The list of available upgrade versions.
ManagedClusterUpgradeProfile	The list of available upgrades for compute pools.
Upgrades	List of orchestrator types and versions available for upgrade.

CloudError

Object

An error response from the Container service.

Name	Type	Description
error	CloudErrorBody	Details about the error.

CloudErrorBody

Object

An error response from the Container service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

ContainerServiceOSTypes

Enumeration

OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux.

Value	Description
Linux
Windows

ManagedClusterPoolUpgradeProfile

Object

The list of available upgrade versions.

Name	Type	Default value	Description
kubernetesVersion	string		Kubernetes version (major, minor, patch).
name	string		Pool name.
osType	ContainerServiceOSTypes	Linux	OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux.
upgrades	Upgrades[]		List of orchestrator types and versions available for upgrade.

ManagedClusterUpgradeProfile

Object

The list of available upgrades for compute pools.

Name	Type	Description
id	string	Id of upgrade profile.
name	string	Name of upgrade profile.
properties.agentPoolProfiles	ManagedClusterPoolUpgradeProfile[]	The list of available upgrade versions for agent pools.
properties.controlPlaneProfile	ManagedClusterPoolUpgradeProfile	The list of available upgrade versions for the control plane.
type	string	Type of upgrade profile.

Upgrades

Object

List of orchestrator types and versions available for upgrade.

Name	Type	Description
isPreview	boolean	Whether Kubernetes version is currently in preview.
kubernetesVersion	string	Kubernetes version (major, minor, patch).