CLI example: Create and manage a Windows pool in Azure Batch
This script demonstrates some of the commands available in the Azure CLI to create and manage a pool of Windows compute nodes in Azure Batch. A Windows pool can be configured in two ways, with either a Cloud Services configuration or a Virtual Machine configuration. This example shows how to create a Windows pool with the Cloud Services configuration.
Use Azure Cloud Shell
Azure hosts Azure Cloud Shell, an interactive shell environment that you can use through your browser. Cloud Shell lets you use either
PowerShell to work with Azure services. You can use the Cloud Shell pre-installed commands to run the code in this article without having to install anything on your local environment.
To launch Azure Cloud Shell:
|Select Try It in the upper-right corner of a code block. Selecting Try It doesn't automatically copy the code to Cloud Shell.|
|Go to https://shell.azure.com or select the Launch Cloud Shell button to open Cloud Shell in your browser.|
|Select the Cloud Shell button on the top-right menu bar in the Azure portal.|
To run the code in this article in Azure Cloud Shell:
- Launch Cloud Shell.
- Select the Copy button on a code block to copy the code.
- Paste the code into the Cloud Shell session with Ctrl+Shift+V on Windows and Linux, or Cmd+Shift+V on macOS.
- Press Enter to run the code.
If you choose to install and use the CLI locally, this article requires that you are running the Azure CLI version 2.0.20 or later. Run
az --version to find the version. If you need to install or upgrade, see Install Azure CLI.
#!/bin/bash # Create a resource group. az group create --name myResourceGroup --location westeurope # Create a Batch account. az batch account create \ --resource-group myResourceGroup \ --name mybatchaccount \ --location westeurope # Authenticate Batch account CLI session. az batch account login \ --resource-group myResourceGroup \ --name mybatchaccount --shared-key-auth # Create a new Windows cloud service platform pool with 3 Standard A1 VMs. # The pool has a start task that runs a basic shell command. Typically a # start task copies application files to the pool nodes. az batch pool create \ --id mypool-windows \ --os-family 4 \ --target-dedicated 3 \ --vm-size small \ --start-task-command-line "cmd /c dir /s" \ --start-task-wait-for-success \ --application-package-references myapp # Add some metadata to the pool. az batch pool set --pool-id mypool-windows --metadata IsWindows=true VMSize=StandardA1 # Change the pool to enable automatic scaling of compute nodes. # This autoscale formula specifies that the number of nodes should be adjusted according # to the number of active tasks, up to a maximum of 10 compute nodes. az batch pool autoscale enable \ --pool-id mypool-windows \ --auto-scale-formula "$averageActiveTaskCount = avg($ActiveTasks.GetSample(TimeInterval_Minute * 15));$TargetDedicated = min(10, $averageActiveTaskCount);" # Monitor the resizing of the pool. az batch pool show --pool-id mypool-windows # Disable autoscaling when we no longer require the pool to automatically scale. az batch pool autoscale disable \ --pool-id mypool-windows
Clean up deployment
Run the following command to remove the resource group and all resources associated with it.
az group delete --name myResourceGroup
This script uses the following commands. Each command in the table links to command-specific documentation.
|az group create||Creates a resource group in which all resources are stored.|
|az batch account create||Creates the Batch account.|
|az batch account login||Authenticates against the specified Batch account for further CLI interaction.|
|az batch pool create||Creates a pool of compute nodes.|
|az batch pool set||Updates the properties of a pool.|
|az batch pool autoscale enable||Enables auto-scaling on a pool and applies a formula.|
|az batch pool show||Displays the properties of a pool.|
|az batch pool autoscale disable||Disables auto-scaling on a pool.|
|az group delete||Deletes a resource group including all nested resources.|
For more information on the Azure CLI, see Azure CLI documentation.