Testing executable doc rendering

rayoef · rayoef · commit 61f5f05b2872 · 2025-03-05T14:41:37.000-07:00
diff --git a/articles/batch/quick-create-cli.md b/articles/batch/quick-create-cli.md
@@ -3,7 +3,7 @@ title: 'Quickstart: Use the Azure CLI to create a Batch account and run a job'
 description: Follow this quickstart to use the Azure CLI to create a Batch account, a pool of compute nodes, and a job that runs basic tasks on the pool.
 ms.topic: quickstart
 ms.date: 04/12/2023
-ms.custom: mvc, devx-track-azurecli, mode-api, linux-related-content
+ms.custom: mvc, devx-track-azurecli, mode-api, linux-related-content, innovation-engine
 ---
 
 # Quickstart: Use the Azure CLI to create a Batch account and run a job
@@ -20,63 +20,91 @@ After you complete this quickstart, you understand the [key concepts of the Batc
 
   You can run the Azure CLI commands in this quickstart interactively in Azure Cloud Shell. To run the commands in the Cloud Shell, select **Open Cloudshell** at the upper-right corner of a code block. Select **Copy** to copy the code, and paste it into Cloud Shell to run it. You can also [run Cloud Shell from within the Azure portal](https://shell.azure.com). Cloud Shell always uses the latest version of the Azure CLI.
 
-  Alternatively, you can [install Azure CLI locally](/cli/azure/install-azure-cli) to run the commands. The steps in this article require Azure CLI version 2.0.20 or later. Run [az version](/cli/azure/reference-index?#az-version) to see your installed version and dependent libraries, and run [az upgrade](/cli/azure/reference-index?#az-upgrade) to upgrade. If you use a local installation, sign in to Azure by using the [az login](/cli/azure/reference-index#az-login) command.
+  Alternatively, you can [install Azure CLI locally](/cli/azure/install-azure-cli) to run the commands. The steps in this article require Azure CLI version 2.0.20 or later. Run [az version](/cli/azure/reference-index?#az-version) to see your installed version and dependent libraries, and run [az upgrade](/cli/azure/reference-index?#az-upgrade) to upgrade. If you use a local installation, sign in to Azure by using the appropriate command.
 
 >[!NOTE]
 >For some regions and subscription types, quota restrictions might cause Batch account or node creation to fail or not complete. In this situation, you can request a quota increase at no charge. For more information, see [Batch service quotas and limits](batch-quota-limit.md).
 
 ## Create a resource group
 
-Run the following [az group create](/cli/azure/group#az-group-create) command to create an Azure resource group named `qsBatch` in the `eastus2` Azure region. The resource group is a logical container that holds the Azure resources for this quickstart.
+Run the following [az group create](/cli/azure/group#az-group-create) command to create an Azure resource group. The resource group is a logical container that holds the Azure resources for this quickstart.
 
 ```azurecli-interactive
+export RANDOM_SUFFIX=$(openssl rand -hex 3)
+export REGION="canadacentral"
+export RESOURCE_GROUP="qsBatch$RANDOM_SUFFIX"
+
 az group create \
-    --name qsBatch \
-    --location eastus2
+    --name $RESOURCE_GROUP \
+    --location $REGION
+```
+
+Results: 
+
+<!-- expected_similarity=0.3 -->
+
+```JSON
+{
+    "id": "/subscriptions/xxxxx/resourceGroups/qsBatchxxx",
+    "location": "eastus2",
+    "managedBy": null,
+    "name": "qsBatchxxx",
+    "properties": {
+         "provisioningState": "Succeeded"
+    },
+    "tags": null,
+    "type": "Microsoft.Resources/resourceGroups"
+}
 ```
 
 ## Create a storage account
 
 Use the [az storage account create](/cli/azure/storage/account#az-storage-account-create) command to create an Azure Storage account to link to your Batch account. Although this quickstart doesn't use the storage account, most real-world Batch workloads use a linked storage account to deploy applications and store input and output data.
 
-Run the following command to create a Standard_LRS SKU storage account named `mybatchstorage` in your resource group:
+Run the following command to create a Standard_LRS SKU storage account in your resource group:
 
 ```azurecli-interactive
+export STORAGE_ACCOUNT="mybatchstorage$RANDOM_SUFFIX"
+
 az storage account create \
-    --resource-group qsBatch \
-    --name mybatchstorage \
-    --location eastus2 \
+    --resource-group $RESOURCE_GROUP \
+    --name $STORAGE_ACCOUNT \
+    --location $REGION \
     --sku Standard_LRS
 ```
 
 ## Create a Batch account
 
-Run the following [az batch account create](/cli/azure/batch/account#az-batch-account-create) command to create a Batch account named `mybatchaccount` in your resource group and link it with the `mybatchstorage` storage account.
+Run the following [az batch account create](/cli/azure/batch/account#az-batch-account-create) command to create a Batch account in your resource group and link it with the storage account.
 
 ```azurecli-interactive
+export BATCH_ACCOUNT="mybatchaccount$RANDOM_SUFFIX"
+
 az batch account create \
-    --name mybatchaccount \
-    --storage-account mybatchstorage \
-    --resource-group qsBatch \
-    --location eastus2
+    --name $BATCH_ACCOUNT \
+    --storage-account $STORAGE_ACCOUNT \
+    --resource-group $RESOURCE_GROUP \
+    --location $REGION
 ```
 
 Sign in to the new Batch account by running the [az batch account login](/cli/azure/batch/account#az-batch-account-login) command. Once you authenticate your account with Batch, subsequent `az batch` commands in this session use this account context.
 
 ```azurecli-interactive
 az batch account login \
-    --name mybatchaccount \
-    --resource-group qsBatch \
+    --name $BATCH_ACCOUNT \
+    --resource-group $RESOURCE_GROUP \
     --shared-key-auth
 ```
 
 ## Create a pool of compute nodes
 
-Run the [az batch pool create](/cli/azure/batch/pool#az-batch-pool-create) command to create a pool of Linux compute nodes in your Batch account. The following example creates a pool named `myPool` that consists of two Standard_A1_v2 size VMs running Ubuntu 20.04 LTS OS. This node size offers a good balance of performance versus cost for this quickstart example.
+Run the [az batch pool create](/cli/azure/batch/pool#az-batch-pool-create) command to create a pool of Linux compute nodes in your Batch account. The following example creates a pool that consists of two Standard_A1_v2 size VMs running Ubuntu 20.04 LTS OS. This node size offers a good balance of performance versus cost for this quickstart example.
 
 ```azurecli-interactive
+export POOL_ID="myPool$RANDOM_SUFFIX"
+
 az batch pool create \
-    --id myPool \
+    --id $POOL_ID \
     --image canonical:0001-com-ubuntu-server-focal:20_04-lts \
     --node-agent-sku-id "batch.node.ubuntu 20.04" \
     --target-dedicated-nodes 2 \
@@ -86,20 +114,32 @@ az batch pool create \
 Batch creates the pool immediately, but takes a few minutes to allocate and start the compute nodes. To see the pool status, use the [az batch pool show](/cli/azure/batch/pool#az-batch-pool-show) command. This command shows all the properties of the pool, and you can query for specific properties. The following command queries for the pool allocation state:
 
 ```azurecli-interactive
-az batch pool show --pool-id myPool \
-    --query "allocationState"
+az batch pool show --pool-id $POOL_ID \
+    --query "{allocationState: allocationState}"
+```
+
+Results: 
+
+<!-- expected_similarity=0.3 -->
+
+```JSON
+{
+    "allocationState": "resizing"
+}
 ```
 
 While Batch allocates and starts the nodes, the pool is in the `resizing` state. You can create a job and tasks while the pool state is still `resizing`. The pool is ready to run tasks when the allocation state is `steady` and all the nodes are running.
 
 ## Create a job
 
-Use the [az batch job create](/cli/azure/batch/job#az-batch-job-create) command to create a Batch job to run on your pool. A Batch job is a logical group of one or more tasks. The job includes settings common to the tasks, such as the pool to run on. The following example creates a job called `myJob` on `myPool` that initially has no tasks.
+Use the [az batch job create](/cli/azure/batch/job#az-batch-job-create) command to create a Batch job to run on your pool. A Batch job is a logical group of one or more tasks. The job includes settings common to the tasks, such as the pool to run on. The following example creates a job that initially has no tasks.
 
 ```azurecli-interactive
+export JOB_ID="myJob$RANDOM_SUFFIX"
+
 az batch job create \
-    --id myJob \
-    --pool-id myPool
+    --id $JOB_ID \
+    --pool-id $POOL_ID
 ```
 
 ## Create job tasks
@@ -113,22 +153,22 @@ for i in {1..4}
 do
    az batch task create \
     --task-id myTask$i \
-    --job-id myJob \
+    --job-id $JOB_ID \
     --command-line "/bin/bash -c 'printenv | grep AZ_BATCH; sleep 90s'"
 done
 ```
 
-The command output shows the settings for each task. Batch distributes the tasks to the compute nodes.
+Batch distributes the tasks to the compute nodes.
 
 ## View task status
 
-After you create the task, Batch queues the task to run on the pool. Once a node is available, the task runs on the node.
+After you create the tasks, Batch queues them to run on the pool. Once a node is available, a task runs on the node.
 
 Use the [az batch task show](/cli/azure/batch/task#az-batch-task-show) command to view the status of Batch tasks. The following example shows details about the status of `myTask1`:
 
 ```azurecli-interactive
 az batch task show \
-    --job-id myJob \
+    --job-id $JOB_ID \
     --task-id myTask1
 ```
 
@@ -139,29 +179,39 @@ The command output includes many details. For example, an `exitCode` of `0` indi
 Use the [az batch task file list](/cli/azure/batch/task#az-batch-task-file-show) command to list the files a task created on a node. The following command lists the files that `myTask1` created:
 
 ```azurecli-interactive
-az batch task file list \
-    --job-id myJob \
-    --task-id myTask1 \
-    --output table
+# Wait for task to complete before downloading output
+echo "Waiting for task to complete..."
+while true; do
+    STATUS=$(az batch task show --job-id $JOB_ID --task-id myTask1 --query "state" -o tsv)
+    if [ "$STATUS" == "running" ]; then
+        break
+    fi
+    sleep 10
+done
+
+az batch task file list --job-id $JOB_ID --task-id myTask1 --output table
 ```
 
 Results are similar to the following output:
 
+Results:
+
+<!-- expected_similarity=0.3 -->
+
 ```output
 Name        URL                                                                                       Is Directory    Content Length
 ----------  ----------------------------------------------------------------------------------------  --------------  ----------------
 stdout.txt  https://mybatchaccount.eastus2.batch.azure.com/jobs/myJob/tasks/myTask1/files/stdout.txt  False                  695
 certs       https://mybatchaccount.eastus2.batch.azure.com/jobs/myJob/tasks/myTask1/files/certs       True
 wd          https://mybatchaccount.eastus2.batch.azure.com/jobs/myJob/tasks/myTask1/files/wd          True
 stderr.txt  https://mybatchaccount.eastus2.batch.azure.com/jobs/myJob/tasks/myTask1/files/stderr.txt  False                    0
-
 ```
 
 The [az batch task file download](/cli/azure/batch/task#az-batch-task-file-download) command downloads output files to a local directory. Run the following example to download the *stdout.txt* file:
 
 ```azurecli-interactive
 az batch task file download \
-    --job-id myJob \
+    --job-id $JOB_ID \
     --task-id myTask1 \
     --file-path stdout.txt \
     --destination ./stdout.txt
@@ -187,25 +237,9 @@ AZ_BATCH_ACCOUNT_NAME=mybatchaccount
 AZ_BATCH_TASK_USER_IDENTITY=PoolNonAdmin
 ```
 
-## Clean up resources
-
-If you want to continue with Batch tutorials and samples, you can use the Batch account and linked storage account that you created in this quickstart. There's no charge for the Batch account itself.
-
-Pools and nodes incur charges while the nodes are running, even if they aren't running jobs. When you no longer need a pool, use the [az batch pool delete](/cli/azure/batch/pool#az-batch-pool-delete) command to delete it. Deleting a pool deletes all task output on the nodes, and the nodes themselves.
-
-```azurecli-interactive
-az batch pool delete --pool-id myPool
-```
-
-When you no longer need any of the resources you created for this quickstart, you can use the [az group delete](/cli/azure/group#az-group-delete) command to delete the resource group and all its resources. To delete the resource group and the storage account, Batch account, node pools, and all related resources, run the following command:
-
-```azurecli-interactive
-az group delete --name qsBatch
-```
-
 ## Next steps
 
 In this quickstart, you created a Batch account and pool, created and ran a Batch job and tasks, and viewed task output from the nodes. Now that you understand the key concepts of the Batch service, you're ready to use Batch with more realistic, larger scale workloads. To learn more about Azure Batch, continue to the Azure Batch tutorials.
 
 > [!div class="nextstepaction"]
-> [Tutorial: Run a parallel workload with Azure Batch](./tutorial-parallel-python.md)
+> [Tutorial: Run a parallel workload with Azure Batch](./tutorial-parallel-python.md)
