Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
This script demonstrates some of the commands available in the Azure CLI to create and manage a pool of Linux compute nodes in Azure Batch.
If you don't have an Azure trial subscription, create an Azure trial subscription before you begin.
If you prefer to run CLI reference commands locally, install the Azure CLI. If you're running on Windows or macOS, consider running Azure CLI in a Docker container. For more information, see How to run the Azure CLI in a Docker container.
If you're using a local installation, sign in to the Azure CLI by using the az login command. To finish the authentication process, follow the steps displayed in your terminal. For other sign-in options, see Sign in with the Azure CLI.
When you're prompted, install the Azure CLI extension on first use. For more information about extensions, see Use extensions with the Azure CLI.
Run az version to find the version and dependent libraries that are installed. To upgrade to the latest version, run az upgrade.
#!/bin/bash
# Create a resource group.
az group create --name myResourceGroup --location chinanorth
# Create a Batch account.
az batch account create \
--resource-group myResourceGroup \
--name mybatchaccount \
--location chinanorth
# Authenticate Batch account CLI session.
az batch account login \
--resource-group myResourceGroup \
--name mybatchaccount
--shared-key-auth
# Retrieve a list of available images and node agent SKUs.
az batch pool node-agent-skus list
# Create a new Linux pool with a virtual machine configuration. The image reference
# and node agent SKUs ID can be selected from the ouptputs of the above list command.
# The image reference is in the format: {publisher}:{offer}:{sku}:{version} where {version} is
# optional and defaults to 'latest'.
az batch pool create \
--id mypool-linux \
--vm-size Standard_A1 \
--image canonical:ubuntuserver:16.04-LTS \
--node-agent-sku-id "batch.node.ubuntu 16.04"
# Resize the pool to start some VMs.
az batch pool resize \
--pool-id mypool-linux \
--target-dedicated 5
# Check the status of the pool to see when it has finished resizing.
az batch pool show \
--pool-id mypool-linux
# List the compute nodes running in a pool.
az batch node list \
--pool-id mypool-linux
# If a particular node in the pool is having issues, it can be rebooted or reimaged.
# The ID of the node can be retrieved with the list command above.
# A typical node ID is in the format 'tvm-xxxxxxxxxx_1-<timestamp>'.
az batch node reboot \
--pool-id mypool-linux \
--node-id tvm-123_1-20170316t000000z
One or more compute nodes can be deleted from the pool, and any work already assigned to it can be re-allocated to another node.
az batch node delete \
--pool-id mypool-linux \
--node-list tvm-123_1-20170316t000000z tvm-123_2-20170316t000000z \
--node-deallocation-option requeue
Use the following command to remove the resource group and all resources associated with it using the az group delete command - unless you have an ongoing need for these resources. Some of these resources may take a while to create, as well as to delete.
az group delete --name myResourceGroup
This script uses the following commands. Each command in the table links to command-specific documentation.
Command | Notes |
---|---|
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 node-agent-skus list | Lists available node agent SKUs and image information. |
az batch pool create | Creates a pool of compute nodes. |
az batch pool resize | Resizes the number of running VMs in the specified pool. |
az batch pool show | Displays the properties of a pool. |
az batch node list | Lists all the compute node in the specified pool. |
az batch node reboot | Reboots the specified compute node. |
az batch node delete | Deletes the listed nodes from the specified pool. |
az group delete | Deletes a resource group including all nested resources. |
For more information on the Azure CLI, see Azure CLI documentation.