Azure Kubernetes Service (AKS) PowerShell Cmdlets

Reference documentation for managing AKS with PowerShell

Azure Kubernetes Service (AKS) PowerShell Cmdlets

This section provides detailed reference information for the Azure PowerShell cmdlets used to manage Azure Kubernetes Service (AKS) clusters.

Get-AzAksCluster

Retrieves information about an Azure Kubernetes Service (AKS) cluster.

Get-AzAksCluster
Get-AzAksCluster -ResourceGroupName "MyResourceGroup"
Get-AzAksCluster -ResourceGroupName "MyResourceGroup" -Name "MyAksCluster"

Parameters:

  • -ResourceGroupName: The name of the resource group.
  • -Name: The name of the AKS cluster.
  • -Expand: Specifies whether to expand the resource information.

Example Output Snippet:

ResourceGroupName : MyResourceGroup
Name              : MyAksCluster
Location          : eastus
KubernetesVersion : 1.27.7
ProvisioningState : Succeeded
...

New-AzAksCluster

Creates a new Azure Kubernetes Service (AKS) cluster.

New-AzAksCluster -ResourceGroupName "MyResourceGroup" -Name "MyNewCluster" -Location "eastus" -NodeCount 3 -GenerateSshKey

Parameters:

  • -ResourceGroupName: The name of the resource group to create the cluster in.
  • -Name: The name of the AKS cluster to create.
  • -Location: The Azure region where the cluster will be created.
  • -NodeCount: The initial number of nodes in the node pool.
  • -GenerateSshKey: Generates SSH public and private key files.
  • ... and many more configuration options.
Note: Cluster creation can take several minutes to complete.

Update-AzAksCluster

Updates an existing Azure Kubernetes Service (AKS) cluster.

Update-AzAksCluster -ResourceGroupName "MyResourceGroup" -Name "MyAksCluster" -NodeCount 4

Parameters:

  • -ResourceGroupName: The name of the resource group.
  • -Name: The name of the AKS cluster to update.
  • -NodeCount: The desired number of nodes in the default node pool.
  • -EnableAutoScaling, -MaxCount, -MinCount: For enabling and configuring autoscaling.

Remove-AzAksCluster

Deletes an Azure Kubernetes Service (AKS) cluster.

Remove-AzAksCluster -ResourceGroupName "MyResourceGroup" -Name "MyAksCluster"
Tip: Use the -Force parameter to bypass the confirmation prompt.

Get-AzAksNodePool

Retrieves information about node pools in an AKS cluster.

Get-AzAksNodePool -ResourceGroupName "MyResourceGroup" -ClusterName "MyAksCluster"

New-AzAksNodePool

Creates a new node pool in an existing AKS cluster.

New-AzAksNodePool -ResourceGroupName "MyResourceGroup" -ClusterName "MyAksCluster" -Name "newNodePool" -NodeCount 2 -VmSize "Standard_DS2_v2"

Update-AzAksNodePool

Updates an existing node pool in an AKS cluster.

Update-AzAksNodePool -ResourceGroupName "MyResourceGroup" -ClusterName "MyAksCluster" -Name "default" -NodeCount 5

Remove-AzAksNodePool

Removes a node pool from an AKS cluster.

Remove-AzAksNodePool -ResourceGroupName "MyResourceGroup" -ClusterName "MyAksCluster" -Name "oldNodePool"

Connect-AzAksCluster

Connects to an AKS cluster by retrieving its kubeconfig.

Connect-AzAksCluster -ResourceGroupName "MyResourceGroup" -Name "MyAksCluster"
Note: This command configures your local Kubernetes context to interact with the AKS cluster.

Enable-AzAksAddonNodePool

Enables an add-on for a specific node pool.

Enable-AzAksAddonNodePool -ResourceGroupName "MyResourceGroup" -ClusterName "MyAksCluster" -Name "default" -AddonName "httpApplicationRouting"

Disable-AzAksAddonNodePool

Disables an add-on for a specific node pool.

Disable-AzAksAddonNodePool -ResourceGroupName "MyResourceGroup" -ClusterName "MyAksCluster" -Name "default" -AddonName "httpApplicationRouting"

For a comprehensive list of all AKS cmdlets and their detailed parameter descriptions, please refer to the official Az.Aks PowerShell Module documentation.