» Data Source: azurerm_kubernetes_cluster

Use this data source to access information about an existing Managed Kubernetes Cluster (AKS).

» Example Usage

data "azurerm_kubernetes_cluster" "test" {
  name                = "myakscluster"
  resource_group_name = "my-example-resource-group"
}

» Argument Reference

The following arguments are supported:

  • name - (Required) The name of the managed Kubernetes Cluster.

  • resource_group_name - (Required) The name of the Resource Group in which the managed Kubernetes Cluster exists.

» Attributes Reference

The following attributes are exported:

  • id - The ID of the Kubernetes Managed Cluster.

  • addon_profile - A addon_profile block as documented below.

  • agent_pool_profile - One or more agent_profile_pool blocks as documented below.

  • dns_prefix - The DNS Prefix of the managed Kubernetes cluster.

  • fqdn - The FQDN of the Azure Kubernetes Managed Cluster.

  • kube_config - A kube_config block as defined below.

  • kube_config_raw - Base64 encoded Kubernetes configuration.

  • kubernetes_version - The version of Kubernetes used on the managed Kubernetes Cluster.

  • location - The Azure Region in which the managed Kubernetes Cluster exists.

  • linux_profile - A linux_profile block as documented below.

  • network_profile - A network_profile block as documented below.

  • node_resource_group - Auto-generated Resource Group containing AKS Cluster resources.

  • role_based_access_control - A role_based_access_control block as documented below.

  • service_principal - A service_principal block as documented below.

  • tags - A mapping of tags assigned to this resource.


A addon_profile block exports the following:


A agent_pool_profile block exports the following:

  • count - The number of Agents (VM's) in the Pool.

  • max_pods - The maximum number of pods that can run on each agent.

  • name - The name assigned to this pool of agents.

  • os_disk_size_gb - The size of the Agent VM's Operating System Disk in GB.

  • os_type - The Operating System used for the Agents.

  • vm_size - The size of each VM in the Agent Pool (e.g. Standard_F1).

  • vnet_subnet_id - The ID of the Subnet where the Agents in the Pool are provisioned.


A azure_active_directory block exports the following:

  • client_app_id - The Client ID of an Azure Active Directory Application.

  • server_app_id - The Server ID of an Azure Active Directory Application.

» * tenant_id - The Tenant ID used for Azure Active Directory Application.

A http_application_routing block exports the following:


A kube_config block exports the following:

  • client_key - Base64 encoded private key used by clients to authenticate to the Kubernetes cluster.

  • client_certificate - Base64 encoded public certificate used by clients to authenticate to the Kubernetes cluster.

  • cluster_ca_certificate - Base64 encoded public CA certificate used as the root of trust for the Kubernetes cluster.

  • host - The Kubernetes cluster server host.

  • username - A username used to authenticate to the Kubernetes cluster.

  • password - A password or token used to authenticate to the Kubernetes cluster.

provider "kubernetes" {
  host                   = "${data.azurerm_kubernetes_cluster.main.kube_config.0.host}"
  username               = "${data.azurerm_kubernetes_cluster.main.kube_config.0.username}"
  password               = "${data.azurerm_kubernetes_cluster.main.kube_config.0.password}"
  client_certificate     = "${base64decode(data.azurerm_kubernetes_cluster.main.kube_config.0.client_certificate)}"
  client_key             = "${base64decode(data.azurerm_kubernetes_cluster.main.kube_config.0.client_key)}"
  cluster_ca_certificate = "${base64decode(data.azurerm_kubernetes_cluster.main.kube_config.0.cluster_ca_certificate)}"
}

A linux_profile block exports the following:

  • admin_username - The username associated with the administrator account of the managed Kubernetes Cluster.

  • ssh_key - One or more ssh_key blocks as defined below.


A network_profile block exports the following:

  • docker_bridge_cidr - IP address (in CIDR notation) used as the Docker bridge IP address on nodes.

  • dns_service_ip - IP address within the Kubernetes service address range used by cluster service discovery (kube-dns).

  • network_plugin - Network plugin used such as azure or kubenet.

  • pod_cidr - The CIDR used for pod IP addresses.

  • service_cidr - Network range used by the Kubernetes service.


A oms_agent block exports the following:


A role_based_access_control block exports the following:


A service_principal block supports the following:

  • client_id - The Client ID of the Service Principal used by this Managed Kubernetes Cluster.

A ssh_key block exports the following:

  • key_data - The Public SSH Key used to access the cluster.