Managed Clusters - Get

Reference

Service:: AKS

API Version:: 2017-08-31

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

HTTP

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

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.
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	ManagedCluster	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

Get Managed Cluster

Sample request

HTTP

HTTP

GET https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1?api-version=2017-08-31

Sample response

Status code:: 200

JSON

{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
  "location": "location1",
  "name": "mycluster1",
  "properties": {
    "agentPoolProfiles": [
      {
        "count": 1,
        "dnsPrefix": "agentpool1dnsPrefix",
        "fqdn": "agentpool1fqdn",
        "name": "agentpool1",
        "osType": "Linux",
        "ports": [
          1
        ],
        "storageProfile": "ManagedDisks",
        "vmSize": "Standard_D2_v2"
      }
    ],
    "dnsPrefix": "dnsprefix1",
    "fqdn": "dnsprefix1-123456.abc.location1.azmk8s.io",
    "kubernetesVersion": "1.7.7",
    "linuxProfile": {
      "adminUsername": "azureuser",
      "ssh": {
        "publicKeys": [
          {
            "keyData": "keydata"
          }
        ]
      }
    },
    "provisioningState": "Succeeded",
    "servicePrincipalProfile": {
      "clientId": "clientid"
    }
  },
  "tags": {
    "archv2": "",
    "tier": "production"
  },
  "type": "Microsoft.ContainerService/ManagedClusters"
}

Definitions

Name	Description
ContainerServiceAgentPoolProfile	Profile for the container service agent pool.
ContainerServiceLinuxProfile	Profile for Linux VMs in the container service cluster.
ContainerServiceServicePrincipalProfile	Information about a service principal identity for the cluster to use for manipulating Azure APIs. Either secret or keyVaultSecretRef must be specified.
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.
KeyVaultSecretRef	Reference to a secret stored in Azure Key Vault.
ManagedCluster	Managed cluster.
OSType	OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux.

ContainerServiceAgentPoolProfile

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.
dnsPrefix	string		DNS prefix to be used to create the FQDN for the agent pool.
fqdn	string		FQDN for the agent pool.
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.
ports	integer[]		Ports number array used to expose on this agent pool. The default opened ports are different based on your choice of orchestrator.
storageProfile	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.
vmSize	ContainerServiceVMSizeTypes		Size of agent VMs.
vnetSubnetID	string		VNet SubnetID specifies the VNet's subnet identifier.

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.

ContainerServiceServicePrincipalProfile

Object

Information about a service principal identity for the cluster to use for manipulating Azure APIs. Either secret or keyVaultSecretRef must be specified.

Name	Type	Description
clientId	string	The ID for the service principal.
keyVaultSecretRef	KeyVaultSecretRef	Reference to a secret stored in Azure Key Vault.
secret	string	The secret password associated with the service principal in plain text.

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

KeyVaultSecretRef

Object

Reference to a secret stored in Azure Key Vault.

Name	Type	Description
secretName	string	The secret name.
vaultID	string	Key vault identifier.
version	string	The secret version.

ManagedCluster

Object

Managed cluster.

Name	Type	Description
id	string	Resource Id
location	string	Resource location
name	string	Resource name
properties.agentPoolProfiles	ContainerServiceAgentPoolProfile[]	Properties of the agent pool.
properties.dnsPrefix	string	DNS prefix specified when creating the managed cluster.
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.provisioningState	string	The current deployment or provisioning state, which only appears in the response.
properties.servicePrincipalProfile	ContainerServiceServicePrincipalProfile	Information about a service principal identity for the cluster to use for manipulating Azure APIs. Either secret or keyVaultSecretRef must be specified.
tags	object	Resource tags
type	string	Resource type

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 - Get

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Get Managed Cluster

Sample request

Sample response

Definitions

ContainerServiceAgentPoolProfile

ContainerServiceLinuxProfile

ContainerServiceServicePrincipalProfile

ContainerServiceSshConfiguration

ContainerServiceSshPublicKey

ContainerServiceStorageProfileTypes

ContainerServiceVMSizeTypes

KeyVaultSecretRef

ManagedCluster

OSType

Additional resources