Quickstart: Using Azure CLI to deploy an AKS hybrid cluster on a Windows Server node in an Azure VM

Article
11/08/2022
10 minutes to read

In this quickstart, you'll learn how to use Azure CLI to test creating AKS hybrid clusters on-premises. You can use this quickstart to run a quick proof of concept on an Azure VM, or if you do not have a Windows Server or Azure Stack HCI cluster.

If you do have a Windows Server or Azure Stack HCI cluster, follow this detailed guide to get started with deploying AKS hybrid clusters from Azure.

Before you begin

Before you begin, make sure you meet the following requirements:

Have access to an Azure subscription.
Make sure you're an owner of the Azure subscription.

Step 1: Register your Azure subscription for features and providers

Register the following Azure providers on your Azure subscription. Make sure you login to Azure first. You only need to do this operation once per Azure subscription.

az provider register --namespace Microsoft.Kubernetes --wait 
az provider register --namespace Microsoft.ExtendedLocation --wait
az provider register --namespace Microsoft.ResourceConnector --wait
az provider register --namespace Microsoft.HybridContainerService --wait
az provider register --namespace Microsoft.HybridConnectivity --wait

Step 2: Create an Azure VM and deploy Windows Server on the Azure VM

To keep things simple, we'll show you how to deploy your VM via an Azure Resource Manager template. The Deploy to Azure button, when clicked, takes you directly to the Azure portal, and upon sign-in, provides you with a form to complete. If you want to open this in a new tab, hold CTRL when you click the button.

After clicking the Deploy to Azure button, enter the details, which should look something similar to those shown below, and click Review and Create.

Screenshot of custom template deployment in Azure.

Note

For customers with Software Assurance, Azure Hybrid Benefit for Windows Server allows you to use your on-premises Windows Server licenses and run Windows virtual machines on Azure at a reduced cost. By selecting Yes for the "Already have a Windows Server License", you confirm you have an eligible Windows Server license with Software Assurance or Windows Server subscription to apply this Azure Hybrid Benefit and have reviewed the Azure hybrid benefit compliance.

The custom template will be validated, and if all of your entries are correct, you can select Create. In 30 minutes, your VM will be created.

Screenshot of custom template deployment completed.

Access your Azure VM

With your Azure Virtual Machine (AKSHCIHost001) successfully deployed and configured, you're ready to connect to the VM using Remote Desktop.

If you're not already signed into the Azure portal, sign in with the same credentials you previously used. Once signed in, enter "azshci" in the search box on the dashboard, and in the search results select your AKSHCIHost001 virtual machine.

In the Overview blade for your VM, at the top of the blade, select Connect, and from the drop-down options select RDP. On the newly opened Connect blade, ensure that Public IP is selected. Also ensure that the RDP port matches what you provided at deployment time. By default, this should be 3389. Then select Download RDP File and choose a suitable folder to store the .rdp file.

Screenshot of RDP settings for Azure Virtual Machine.

Once downloaded, locate the .rdp file on your local machine, and double-click to open it. Click Connect and when prompted, enter the credentials you supplied when creating the VM earlier. Accept any certificate prompts, and within a few minutes you should be successfully logged into the Azure VM.

Step 3: Install Azure CLI on the Azure VM

Once you've logged into the Azure VM, run the following command to install Az CLI.

$ProgressPreference = 'SilentlyContinue'; Invoke-WebRequest -Uri https://aka.ms/installazurecliwindows -OutFile .\AzureCLI.msi; Start-Process msiexec.exe -Wait -ArgumentList '/I AzureCLI.msi /quiet'; rm .\AzureCLI.msi
Exit

Step 4: Install Az CLI extensions on the Azure VM

$env:PATH += ";C:\Program Files (x86)\Microsoft SDKs\Azure\CLI2\wbin;"
az extension add -n k8s-extension --upgrade
az extension add -n customlocation --upgrade
az extension add -n arcappliance --upgrade --version 0.2.27
az extension add -n hybridaks --upgrade

Step 5: Install pre-requisite PowerShell repositories

Close all open PowerShell windows on your Azure VM and open a fresh new PowerShell admin window and run the following command:

Set-PSRepository -Name "PSGallery" -InstallationPolicy Trusted 
Install-PackageProvider -Name NuGet -Force  
Install-Module -Name PowershellGet -Force 
Exit