I need the list AKS cluster names, node pool and node names using powershell

Question

I need the list AKS cluster names, node pool and node names using powershell

Girish Prajwal 706

Hi Team, I need the list AKS cluster names, node pool and node names using powershell.

Akram Kathimi 1,206 Microsoft Employee

Hi @Girish Prajwal ,

Thank you for your question.

You can use the Get-AzAksCluster cmdlet to list all Kubernetes clusters in your subscription. You can also use the -ResourceGroupName parameter to specify the resource group name of the cluster and -Name parameter to specify the name of your managed Kubernetes cluster. Here is an example command:

Get-AzAksCluster -ResourceGroupName "myResourceGroup" -Name "myAKSCluster"

To format the output of the above command while listing all clusters use:

Get-AzAksCluster | Format-Table Name,AgentPoolProfiles

To list all node pools in a cluster, you can use the az aks nodepool list command. Here is an example command:

az aks nodepool list --resource-group myResourceGroup --cluster-name myAKSCluster --output table

To get the names of nodes in a node pool, you can use the kubectl get nodes command. Here is an example command:

kubectl get nodes --selector=nodepool=myNodePoolName

For a fully automated powershell only version, use this:

$aksClusters = Get-AzAksCluster

foreach ($aksCluster in $aksClusters) {
    Write-Host "AKS Cluster: $($aksCluster.Name)"
    $nodePools = Get-AzAksNodepool -ResourceGroupName ($aksCluster.Id.Split('/')[4]) -ClusterName $aksCluster.Name

    foreach ($nodePool in $nodePools) {
        Write-Host "  Node Pool: $($nodePool.Name)"
        $vmssName = (Get-AzVmss -ResourceGroupName $aksCluster.NodeResourceGroup | Where-Object {$_.Tags['aks-managed-poolName'] -eq $nodePool.Name}).Name
        $vmssInstances = Get-AzVmssVM -ResourceGroupName $aksCluster.NodeResourceGroup -VMScaleSetName $vmssName

        foreach ($vmssInstance in $vmssInstances) {
            Write-Host "    VM: $($vmssInstance.Name)"
        }
    }
}
~

Please Accept the answer if the information helped you. This will help us and others in the community as well.

Girish Prajwal 706 Reputation points

2023-05-09T19:38:15.1166667+00:00

Hi Akram, I am not using CLI commands nor kubectl. I want the node names of each Node pool in the AKS cluster using powershell only. I know how to get the node counts and the size of each node pool. However, I need this info.
Prrudram-MSFT 28,201 Reputation points Moderator

2023-05-10T06:24:36.63+00:00

Hello @Girish Prajwal

If an answer has been helpful, please consider accepting the answer to help increase visibility of this question for other members of the Microsoft Q&A community. If not, please let us know what is still needed in the comments so the question can be answered. Thank you for helping to improve Microsoft Q&A!

Akram Kathimi 1,206 Microsoft Employee

@Girish Prajwal Here is a fully automated powershell script that does what you need. If you want more information feel free to tweak it accordingly :).

PS. added it to the original answer for clarity.

Hope this helps!

$aksClusters = Get-AzAksCluster

foreach ($aksCluster in $aksClusters) {
    Write-Host "AKS Cluster: $($aksCluster.Name)"
    $nodePools = Get-AzAksNodepool -ResourceGroupName ($aksCluster.Id.Split('/')[4]) -ClusterName $aksCluster.Name

    foreach ($nodePool in $nodePools) {
        Write-Host "  Node Pool: $($nodePool.Name)"
        $vmssName = (Get-AzVmss -ResourceGroupName $aksCluster.NodeResourceGroup | Where-Object {$_.Tags['aks-managed-poolName'] -eq $nodePool.Name}).Name
        $vmssInstances = Get-AzVmssVM -ResourceGroupName $aksCluster.NodeResourceGroup -VMScaleSetName $vmssName

        foreach ($vmssInstance in $vmssInstances) {
            Write-Host "    VM: $($vmssInstance.Name)"
        }
    }
}

Accepted answer

0 additional answers

Your answer

Akram Kathimi 1,206 Reputation points Microsoft Employee

2023-05-09T14:22:27.3133333+00:00

Hi @Girish Prajwal ,

Thank you for your question.

You can use the Get-AzAksCluster cmdlet to list all Kubernetes clusters in your subscription. You can also use the -ResourceGroupName parameter to specify the resource group name of the cluster and -Name parameter to specify the name of your managed Kubernetes cluster. Here is an example command:

Get-AzAksCluster -ResourceGroupName "myResourceGroup" -Name "myAKSCluster"

To format the output of the above command while listing all clusters use:

Get-AzAksCluster | Format-Table Name,AgentPoolProfiles

To list all node pools in a cluster, you can use the az aks nodepool list command. Here is an example command:

az aks nodepool list --resource-group myResourceGroup --cluster-name myAKSCluster --output table

To get the names of nodes in a node pool, you can use the kubectl get nodes command. Here is an example command:

kubectl get nodes --selector=nodepool=myNodePoolName

For a fully automated powershell only version, use this:

$aksClusters = Get-AzAksCluster foreach ($aksCluster in $aksClusters) { Write-Host "AKS Cluster: $($aksCluster.Name)" $nodePools = Get-AzAksNodepool -ResourceGroupName ($aksCluster.Id.Split('/')[4]) -ClusterName $aksCluster.Name foreach ($nodePool in $nodePools) { Write-Host " Node Pool: $($nodePool.Name)" $vmssName = (Get-AzVmss -ResourceGroupName $aksCluster.NodeResourceGroup | Where-Object {$_.Tags['aks-managed-poolName'] -eq $nodePool.Name}).Name $vmssInstances = Get-AzVmssVM -ResourceGroupName $aksCluster.NodeResourceGroup -VMScaleSetName $vmssName foreach ($vmssInstance in $vmssInstances) { Write-Host " VM: $($vmssInstance.Name)" } } } ~

Please Accept the answer if the information helped you. This will help us and others in the community as well.
Girish Prajwal 706 Reputation points

2023-05-09T19:38:15.1166667+00:00

Hi Akram, I am not using CLI commands nor kubectl. I want the node names of each Node pool in the AKS cluster using powershell only. I know how to get the node counts and the size of each node pool. However, I need this info.
Prrudram-MSFT 28,201 Reputation points Moderator

2023-05-10T06:24:36.63+00:00

Hello @Girish Prajwal

If an answer has been helpful, please consider accepting the answer to help increase visibility of this question for other members of the Microsoft Q&A community. If not, please let us know what is still needed in the comments so the question can be answered. Thank you for helping to improve Microsoft Q&A!
Akram Kathimi 1,206 Reputation points Microsoft Employee

2023-05-10T08:51:16.5233333+00:00

@Girish Prajwal Here is a fully automated powershell script that does what you need. If you want more information feel free to tweak it accordingly :).

PS. added it to the original answer for clarity.

Hope this helps!

$aksClusters = Get-AzAksCluster foreach ($aksCluster in $aksClusters) { Write-Host "AKS Cluster: $($aksCluster.Name)" $nodePools = Get-AzAksNodepool -ResourceGroupName ($aksCluster.Id.Split('/')[4]) -ClusterName $aksCluster.Name foreach ($nodePool in $nodePools) { Write-Host " Node Pool: $($nodePool.Name)" $vmssName = (Get-AzVmss -ResourceGroupName $aksCluster.NodeResourceGroup | Where-Object {$_.Tags['aks-managed-poolName'] -eq $nodePool.Name}).Name $vmssInstances = Get-AzVmssVM -ResourceGroupName $aksCluster.NodeResourceGroup -VMScaleSetName $vmssName foreach ($vmssInstance in $vmssInstances) { Write-Host " VM: $($vmssInstance.Name)" } } }

Answer 1

Hi @Girish Prajwal

You can get the list of AKS cluster names and node pool names using the PowerShell script below.

# Get the list of AKS clusters
$aksClusters = Get-AzAksCluster

# Loop through each AKS cluster and get the node pool and node names
foreach ($aksCluster in $aksClusters) {
    $aksClusterName = $aksCluster.Name
    $aksResourceGroup = $aksCluster.ResourceGroupName
    write-output "AKS Clusters: $aksClusterName"
    $aksNodepool = Get-AzAksNodepool -ResourceGroupName $aksResourceGroup -ClusterName $aksClusterName
    
   foreach ( $item in $aksNodepool)
   {
    Write-Output "AKS NodePools: $item. Name"
   }
}

For the node names list you need to use the Kubectl commands:

kubectl get nodes -l "type=virtual-node,node-role.kubernetes.io/agentpool=<node-pool-name>"

The AKS node names are not included in the node pool properties because node names are assigned by the Kubernetes and are not related to the node pool. When you create an AKS cluster, Kubernetes creates a set of nodes to run your workloads. These nodes are created in a node pool, which is a logical grouping of nodes with similar configurations. However, the node names are assigned by Kubernetes and are not related to the node pool.

You can use the kubectl get nodes command to get the list of nodes in your AKS cluster, and the kubectl describe node <node-name> command to get detailed information about a specific node, including its name. However, the node names are not included in the node pool properties because they are not related to the node pool.

If this does answer your question, please accept it as the answer as a token of appreciation.

Share via

I need the list AKS cluster names, node pool and node names using powershell

0 additional answers

Your answer