Managed Clusters - List

Reference

Service:: AKS

API Version:: 2018-03-31

Gets a list of managed clusters in the specified subscription. The operation returns properties of each managed cluster.

HTTP

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedClusters?api-version=2018-03-31

URI Parameters

Name	In	Required	Type	Description
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	ManagedClusterListResult	OK

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

List Managed Clusters

Sample request

HTTP

HTTP

GET https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/managedClusters?api-version=2018-03-31

Sample response

Status code:: 200

JSON

{
  "value": [
    {
      "id": "/subscriptions/subid1/providers/Microsoft.ContainerService/managedClusters",
      "location": "location1",
      "name": "clustername1",
      "tags": {
        "archv2": "",
        "tier": "production"
      },
      "type": "Microsoft.ContainerService/ManagedClusters",
      "properties": {
        "provisioningState": "Succeeded",
        "kubernetesVersion": "1.9.6",
        "dnsPrefix": "dnsprefix1",
        "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
        "agentPoolProfiles": [
          {
            "name": "nodepool1",
            "count": 3,
            "vmSize": "Standard_DS1_v2",
            "storageProfile": "ManagedDisks",
            "maxPods": 110,
            "osType": "Linux"
          }
        ],
        "linuxProfile": {
          "adminUsername": "azureuser",
          "ssh": {
            "publicKeys": [
              {
                "keyData": "keydata"
              }
            ]
          }
        },
        "servicePrincipalProfile": {
          "clientId": "clientid"
        },
        "nodeResourceGroup": "MC_rg1_clustername1_location1",
        "enableRBAC": false,
        "networkProfile": {
          "networkPlugin": "kubenet",
          "podCidr": "10.244.0.0/16",
          "serviceCidr": "10.0.0.0/16",
          "dnsServiceIP": "10.0.0.10",
          "dockerBridgeCidr": "172.17.0.1/16"
        }
      }
    }
  ]
}

Definitions

Name	Description
ContainerServiceLinuxProfile	Profile for Linux VMs in the container service cluster.
ContainerServiceNetworkProfile	Profile of network configuration.
ContainerServiceSshConfiguration	SSH configuration for Linux-based VMs running on Azure.
ContainerServiceSshPublicKey	Contains information about SSH certificate public key data.
ContainerServiceStorageProfileTypes	Storage profile specifies what kind of storage used. Choose from StorageAccount and ManagedDisks. Leave it empty, we will choose for you based on the orchestrator choice.
ContainerServiceVMSizeTypes	Size of agent VMs.
ManagedCluster	Managed cluster.
ManagedClusterAADProfile	AADProfile specifies attributes for Azure Active Directory integration.
ManagedClusterAddonProfile	A Kubernetes add-on profile for a managed cluster.
ManagedClusterAgentPoolProfile	Profile for the container service agent pool.
ManagedClusterListResult	The response from the List Managed Clusters operation.
ManagedClusterServicePrincipalProfile	Information about a service principal identity for the cluster to use for manipulating Azure APIs.
NetworkPlugin	Network plugin used for building Kubernetes network.
NetworkPolicy	Network policy used for building Kubernetes network.
OSType	OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux.

ContainerServiceLinuxProfile

Object

Profile for Linux VMs in the container service cluster.

Name	Type	Description
adminUsername	string	The administrator username to use for Linux VMs.
ssh	ContainerServiceSshConfiguration	SSH configuration for Linux-based VMs running on Azure.

ContainerServiceNetworkProfile

Object

Profile of network configuration.

Name	Type	Default value	Description
dnsServiceIP	string	10.0.0.10	An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.
dockerBridgeCidr	string	172.17.0.1/16	A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range.
networkPlugin	NetworkPlugin	kubenet	Network plugin used for building Kubernetes network.
networkPolicy	NetworkPolicy		Network policy used for building Kubernetes network.
podCidr	string	10.244.0.0/16	A CIDR notation IP range from which to assign pod IPs when kubenet is used.
serviceCidr	string	10.0.0.0/16	A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.

ContainerServiceSshConfiguration

Object

SSH configuration for Linux-based VMs running on Azure.

Name	Type	Description
publicKeys	ContainerServiceSshPublicKey[]	The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified.

ContainerServiceSshPublicKey

Object

Contains information about SSH certificate public key data.

Name	Type	Description
keyData	string	Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers.

ContainerServiceStorageProfileTypes

Enumeration

Storage profile specifies what kind of storage used. Choose from StorageAccount and ManagedDisks. Leave it empty, we will choose for you based on the orchestrator choice.

Value	Description
ManagedDisks
StorageAccount

ContainerServiceVMSizeTypes

Enumeration

Size of agent VMs.

Value	Description
Standard_A1
Standard_A10
Standard_A11
Standard_A1_v2
Standard_A2
Standard_A2_v2
Standard_A2m_v2
Standard_A3
Standard_A4
Standard_A4_v2
Standard_A4m_v2
Standard_A5
Standard_A6
Standard_A7
Standard_A8
Standard_A8_v2
Standard_A8m_v2
Standard_A9
Standard_B2ms
Standard_B2s
Standard_B4ms
Standard_B8ms
Standard_D1
Standard_D11
Standard_D11_v2
Standard_D11_v2_Promo
Standard_D12
Standard_D12_v2
Standard_D12_v2_Promo
Standard_D13
Standard_D13_v2
Standard_D13_v2_Promo
Standard_D14
Standard_D14_v2
Standard_D14_v2_Promo
Standard_D15_v2
Standard_D16_v3
Standard_D16s_v3
Standard_D1_v2
Standard_D2
Standard_D2_v2
Standard_D2_v2_Promo
Standard_D2_v3
Standard_D2s_v3
Standard_D3
Standard_D32_v3
Standard_D32s_v3
Standard_D3_v2
Standard_D3_v2_Promo
Standard_D4
Standard_D4_v2
Standard_D4_v2_Promo
Standard_D4_v3
Standard_D4s_v3
Standard_D5_v2
Standard_D5_v2_Promo
Standard_D64_v3
Standard_D64s_v3
Standard_D8_v3
Standard_D8s_v3
Standard_DS1
Standard_DS11
Standard_DS11_v2
Standard_DS11_v2_Promo
Standard_DS12
Standard_DS12_v2
Standard_DS12_v2_Promo
Standard_DS13
Standard_DS13-2_v2
Standard_DS13-4_v2
Standard_DS13_v2
Standard_DS13_v2_Promo
Standard_DS14
Standard_DS14-4_v2
Standard_DS14-8_v2
Standard_DS14_v2
Standard_DS14_v2_Promo
Standard_DS15_v2
Standard_DS1_v2
Standard_DS2
Standard_DS2_v2
Standard_DS2_v2_Promo
Standard_DS3
Standard_DS3_v2
Standard_DS3_v2_Promo
Standard_DS4
Standard_DS4_v2
Standard_DS4_v2_Promo
Standard_DS5_v2
Standard_DS5_v2_Promo
Standard_E16_v3
Standard_E16s_v3
Standard_E2_v3
Standard_E2s_v3
Standard_E32-16s_v3
Standard_E32-8s_v3
Standard_E32_v3
Standard_E32s_v3
Standard_E4_v3
Standard_E4s_v3
Standard_E64-16s_v3
Standard_E64-32s_v3
Standard_E64_v3
Standard_E64s_v3
Standard_E8_v3
Standard_E8s_v3
Standard_F1
Standard_F16
Standard_F16s
Standard_F16s_v2
Standard_F1s
Standard_F2
Standard_F2s
Standard_F2s_v2
Standard_F32s_v2
Standard_F4
Standard_F4s
Standard_F4s_v2
Standard_F64s_v2
Standard_F72s_v2
Standard_F8
Standard_F8s
Standard_F8s_v2
Standard_G1
Standard_G2
Standard_G3
Standard_G4
Standard_G5
Standard_GS1
Standard_GS2
Standard_GS3
Standard_GS4
Standard_GS4-4
Standard_GS4-8
Standard_GS5
Standard_GS5-16
Standard_GS5-8
Standard_H16
Standard_H16m
Standard_H16mr
Standard_H16r
Standard_H8
Standard_H8m
Standard_L16s
Standard_L32s
Standard_L4s
Standard_L8s
Standard_M128-32ms
Standard_M128-64ms
Standard_M128ms
Standard_M128s
Standard_M64-16ms
Standard_M64-32ms
Standard_M64ms
Standard_M64s
Standard_NC12
Standard_NC12s_v2
Standard_NC12s_v3
Standard_NC24
Standard_NC24r
Standard_NC24rs_v2
Standard_NC24rs_v3
Standard_NC24s_v2
Standard_NC24s_v3
Standard_NC6
Standard_NC6s_v2
Standard_NC6s_v3
Standard_ND12s
Standard_ND24rs
Standard_ND24s
Standard_ND6s
Standard_NV12
Standard_NV24
Standard_NV6

ManagedCluster

Object

Managed cluster.

Name	Type	Description
id	string	Resource Id
location	string	Resource location
name	string	Resource name
properties.aadProfile	ManagedClusterAADProfile	Profile of Azure Active Directory configuration.
properties.addonProfiles	<string, ManagedClusterAddonProfile>	Profile of managed cluster add-on.
properties.agentPoolProfiles	ManagedClusterAgentPoolProfile[]	Properties of the agent pool. Currently only one agent pool can exist.
properties.dnsPrefix	string	DNS prefix specified when creating the managed cluster.
properties.enableRBAC	boolean	Whether to enable Kubernetes Role-Based Access Control.
properties.fqdn	string	FQDN for the master pool.
properties.kubernetesVersion	string	Version of Kubernetes specified when creating the managed cluster.
properties.linuxProfile	ContainerServiceLinuxProfile	Profile for Linux VMs in the container service cluster.
properties.networkProfile	ContainerServiceNetworkProfile	Profile of network configuration.
properties.nodeResourceGroup	string	Name of the resource group containing agent pool nodes.
properties.provisioningState	string	The current deployment or provisioning state, which only appears in the response.
properties.servicePrincipalProfile	ManagedClusterServicePrincipalProfile	Information about a service principal identity for the cluster to use for manipulating Azure APIs.
tags	object	Resource tags
type	string	Resource type

ManagedClusterAADProfile

Object

AADProfile specifies attributes for Azure Active Directory integration.

Name	Type	Description
clientAppID	string	The client AAD application ID.
serverAppID	string	The server AAD application ID.
serverAppSecret	string	The server AAD application secret.
tenantID	string	The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription.

ManagedClusterAddonProfile

Object

A Kubernetes add-on profile for a managed cluster.

Name	Type	Description
config	object	Key-value pairs for configuring an add-on.
enabled	boolean	Whether the add-on is enabled or not.

ManagedClusterAgentPoolProfile

Object

Profile for the container service agent pool.

Name	Type	Default value	Description
count	integer	1	Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.
maxPods	integer		Maximum number of pods that can run on a node.
name	string		Unique name of the agent pool profile in the context of the subscription and resource group.
osDiskSizeGB	integer		OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified.
osType	OSType	Linux	OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux.
storageProfile	ContainerServiceStorageProfileTypes		Storage profile specifies what kind of storage used. Defaults to ManagedDisks.
vmSize	ContainerServiceVMSizeTypes		Size of agent VMs.
vnetSubnetID	string		VNet SubnetID specifies the VNet's subnet identifier.

ManagedClusterListResult

Object

The response from the List Managed Clusters operation.

Name	Type	Description
nextLink	string	The URL to get the next set of managed cluster results.
value	ManagedCluster[]	The list of managed clusters.

ManagedClusterServicePrincipalProfile

Object

Information about a service principal identity for the cluster to use for manipulating Azure APIs.

Name	Type	Description
clientId	string	The ID for the service principal.
secret	string	The secret password associated with the service principal in plain text.

NetworkPlugin

Enumeration

Network plugin used for building Kubernetes network.

Value	Description
azure
kubenet

NetworkPolicy

Enumeration

Network policy used for building Kubernetes network.

Value	Description
calico

OSType

Enumeration

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

Value	Description
Linux
Windows

Share via

Managed Clusters - List

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

List Managed Clusters

Sample request

Sample response

Definitions

ContainerServiceLinuxProfile

ContainerServiceNetworkProfile

ContainerServiceSshConfiguration

ContainerServiceSshPublicKey

ContainerServiceStorageProfileTypes

ContainerServiceVMSizeTypes

ManagedCluster

ManagedClusterAADProfile

ManagedClusterAddonProfile

ManagedClusterAgentPoolProfile

ManagedClusterListResult

ManagedClusterServicePrincipalProfile

NetworkPlugin

NetworkPolicy

OSType

Additional resources