This table represents the AKS Cluster resource from Microsoft Azure.

azure.aks_cluster

Fields

TitleIDTypeData TypeDescription
_keycorestring
aad_profilecorejsonThe Azure Active Directory configuration.
agent_pool_profilescorejsonThe agent pool properties.
api_server_access_profilecorejsonThe access profile for managed cluster API server.
auto_scaler_profilecorejsonParameters to be applied to the cluster-autoscaler when enabled
auto_upgrade_profilecorejsonThe auto upgrade configuration.
azure_monitor_profilecorejson
azure_portal_fqdncorestringThe Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly.
bootstrap_profilecorejsonProfile of the cluster bootstrap configuration.
current_kubernetes_versioncorestringIf kubernetesVersion was a fully specified version <major.minor.patch>, this field will be exactly equal to it. If kubernetesVersion was <major.minor>, this field will contain the full <major.minor.patch> version being used.
disable_local_accountscoreboolIf set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview).
disk_encryption_set_idcorestringThis is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'
dns_prefixcorestringThis cannot be updated once the Managed Cluster has been created.
e_tagcorestringUnique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention.
enable_pod_security_policycorebool(DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp.
enable_rbaccoreboolWhether to enable Kubernetes Role-Based Access Control.
fqdncorestringThe FQDN of the master pool.
fqdn_subdomaincorestringThis cannot be updated once the Managed Cluster has been created.
http_proxy_configcorejsonConfigurations for provisioning the cluster with HTTP proxy servers.
idcorestringFully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identitycorejsonThe identity of the managed cluster, if configured.
ingress_profilecorejsonIngress profile for the managed cluster.
kubernetes_versioncorestringBoth patch version <major.minor.patch> (e.g. 1.20.13) and <major.minor> (e.g. 1.20) are supported. When <major.minor> is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same <major.minor> once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details.
linux_profilecorejsonThe profile for Linux VMs in the Managed Cluster.
locationcorestringThe geo-location where the resource lives
max_agent_poolscoreint64The max number of agent pools for the managed cluster.
metrics_profilecorejsonOptional cluster metrics configuration.
namecorestringThe name of the resource
network_profilecorejsonThe network configuration profile.
node_resource_groupcorestringThe name of the resource group containing agent pool nodes.
node_resource_group_profilecorejsonProfile of the node resource group configuration.
oidc_issuer_profilecorejsonThe OIDC issuer profile of the Managed Cluster.
pod_identity_profilecorejsonSee [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on AAD pod identity integration.
power_statecorejsonThe Power State of the cluster.
private_fqdncorestringThe FQDN of private cluster.
private_link_resourcescorejsonPrivate link resources associated with the cluster.
provisioning_statecorestringThe current provisioning state.
public_network_accesscorestringAllow or deny public network access for AKS
resource_groupcorestring
resource_uidcorestringThe resourceUID uniquely identifies ManagedClusters that reuse ARM ResourceIds (i.e: create, delete, create sequence)
security_profilecorejsonSecurity profile for the managed cluster.
service_mesh_profilecorejson
service_principal_profilecorejsonInformation about a service principal identity for the cluster to use for manipulating Azure APIs.
skucorejsonThe managed cluster SKU.
storage_profilecorejsonStorage profile for the managed cluster.
subscription_idcorestring
subscription_namecorestring
support_plancorestringThe support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'.
system_datacorejsonAzure Resource Manager metadata containing createdBy and modifiedBy information.
tagscorehstore_csv
typecorestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
upgrade_settingscorejsonSettings for upgrading a cluster.
windows_profilecorejsonThe profile for Windows VMs in the Managed Cluster.
workload_auto_scaler_profilecorejson