Skip to content

Commit e0d1ae8

Browse files
authored
Merge pull request #91359 from johndowns/batch-autoscale-variables
Add explanation of variable aliases for Azure Batch automatic scaling formulas
2 parents 7e642d7 + 5d703b0 commit e0d1ae8

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

articles/batch/batch-automatic-scaling.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.tgt_pltfrm:
1414
ms.workload: multiple
1515
ms.date: 10/08/2019
1616
ms.author: lahugh
17-
ms.custom: H1Hack27Feb2017
17+
ms.custom: H1Hack27Feb2017,fasttrack-edit
1818

1919
---
2020
# Create an automatic formula for scaling compute nodes in a Batch pool
@@ -104,6 +104,11 @@ You can get and set the values of these service-defined variables to manage the
104104
| $TargetLowPriorityNodes |The target number of low-priority compute nodes for the pool. The number of low-priority nodes is specified as a target because a pool may not always achieve the desired number of nodes. For example, if the target number of low-priority nodes is modified by an autoscale evaluation before the pool has reached the initial target, then the pool may not reach the target. A pool may also not achieve its target if the target exceeds a Batch account node or core quota. <br /><br /> For more information on low-priority compute nodes, see [Use low-priority VMs with Batch (Preview)](batch-low-pri-vms.md). |
105105
| $NodeDeallocationOption |The action that occurs when compute nodes are removed from a pool. Possible values are:<ul><li>**requeue**-- The default value. Terminates tasks immediately and puts them back on the job queue so that they are rescheduled. This action ensures the target number of nodes is reach as quickly as possible, but may be less efficient, as any running tasks will be interrupted and have to be restarted, wasting any work they had already done. <li>**terminate**--Terminates tasks immediately and removes them from the job queue.<li>**taskcompletion**--Waits for currently running tasks to finish and then removes the node from the pool. Use this option to avoid tasks being interrupted and requeued, wasting any work the task has done. <li>**retaineddata**--Waits for all the local task-retained data on the node to be cleaned up before removing the node from the pool.</ul> |
106106

107+
> [!NOTE]
108+
> The `$TargetDedicatedNodes` variable can also be specified using the alias `$TargetDedicated`. Similarly, the `$TargetLowPriorityNodes` variable can be specified using the alias `$TargetLowPriority`. If both the fully named variable and its alias are set by the formula, the value assigned to the fully named variable will take precedence.
109+
>
110+
>
111+
107112
You can get the value of these service-defined variables to make adjustments that are based on metrics from the Batch service:
108113

109114
| Read-only service-defined variables | Description |

0 commit comments

Comments
 (0)