Az.ContainerService Module Reference

Overview

This module provides cmdlets for managing Azure Container Service (AKS) resources. You can use these cmdlets to create, configure, and manage Kubernetes clusters in Azure.

Cmdlets

New-AzAksCluster

Creates a new Azure Kubernetes Service (AKS) cluster.
New-AzAksCluster -ResourceGroupName <String> -Name <String> [-Location <String>] [-NodeCount <Int32>] [...]

-ResourceGroupName (Required) The name of the resource group.

-Name (Required) The name of the AKS cluster.

-Location The Azure region to deploy the cluster in.

-NodeCount The initial number of nodes in the node pool.
Get-AzAksCluster

Gets information about an AKS cluster or lists AKS clusters in a resource group.
Get-AzAksCluster [-ResourceGroupName <String>] [-Name <String>] [...]

-ResourceGroupName The name of the resource group. If not specified, lists clusters across all resource groups.

-Name The name of the AKS cluster.
Update-AzAksCluster

Updates an AKS cluster.
Update-AzAksCluster -ResourceGroupName <String> -Name <String> [-NodeCount <Int32>] [...]

-ResourceGroupName (Required) The name of the resource group.

-Name (Required) The name of the AKS cluster.

-NodeCount The desired number of nodes in the node pool.
Remove-AzAksCluster

Deletes an AKS cluster.
Remove-AzAksCluster -ResourceGroupName <String> -Name <String> [-Force] [-AsJob] [...]

-ResourceGroupName (Required) The name of the resource group.

-Name (Required) The name of the AKS cluster.

-Force Suppresses the confirmation prompt.
Get-AzAksCredential

Gets the kubeconfig for an AKS cluster.
Get-AzAksCredential -ResourceGroupName <String> -Name <String> [...]

-ResourceGroupName (Required) The name of the resource group.

-Name (Required) The name of the AKS cluster.

Examples

Creating a basic AKS cluster


                    # Sign in to Azure first
                    Connect-AzAccount

                    # Define resource group and cluster name
                    $resourceGroup = "myResourceGroup"
                    $clusterName = "myAksCluster"

                    # Create the AKS cluster
                    New-AzAksCluster -ResourceGroupName $resourceGroup -Name $clusterName -NodeCount 3 -Location "eastus"

Listing all AKS clusters in a subscription


                    Get-AzAksCluster

Updating the node count of an existing cluster


                    $resourceGroup = "myResourceGroup"
                    $clusterName = "myAksCluster"

                    Update-AzAksCluster -ResourceGroupName $resourceGroup -Name $clusterName -NodeCount 5

Azure Documentation

Az.ContainerService Module Reference

Overview

Cmdlets

Examples

Creating a basic AKS cluster

Listing all AKS clusters in a subscription

Updating the node count of an existing cluster

Related Cmdlets