Start-​Azure​Batch​Pool​Resize

Starts to resize a pool.

Syntax

Start-AzureBatchPoolResize
     [-Id] <String>
     -BatchContext <BatchAccountContext>
     [-ComputeNodeDeallocationOption <ComputeNodeDeallocationOption>]
     [-ResizeTimeout <TimeSpan>]
     -TargetDedicated <Int32>
     [<CommonParameters>]

Description

The Start-AzureBatchPoolResize cmdlet starts an Azure Batch resize operation on a pool.

Examples

Example 1: Resize a pool to 12 nodes

PS C:\>Start-AzureBatchPoolResize -Id "ContosoPool06" -TargetDedicated 12 -BatchContext $Context

This command starts a resize operation on the pool that has the ID ContosoPool06. The target for the operation is 12 dedicated compute nodes. Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable.

Example 2: Resize a pool using a deallocation option

PS C:\>Get-AzureBatchPool -Id "ContosoPool06" -BatchContext $Context | Start-AzureBatchPoolResize -TargetDedicated 5 -ResizeTimeout ([TimeSpan]::FromHours(1)) -ComputeNodeDeallocationOption ([Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption]::Terminate) -BatchContext $Context

This cmdlet resizes a pool to five dedicated compute nodes. The command gets the pool that has the ID ContosoPool06 by using the Get-AzureBatchPool cmdlet. The command passes that pool object to the current cmdlet by using the pipeline operator. The command starts a resize operation on the pool. The target is five dedicated compute nodes. The command specifies time-out period of one hour. The command specifies a deallocation option of Terminate.

Required Parameters

-BatchContext

Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.

Type:BatchAccountContext
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Id

Specifies the ID of the pool that this cmdlet resizes.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False
-TargetDedicated

Specifies the target number of dedicated compute nodes.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-ComputeNodeDeallocationOption

Specifies a deallocation option for the resizing operation that this cmdlet starts.

Type:ComputeNodeDeallocationOption
Parameter Sets:Requeue, Terminate, TaskCompletion, RetainedData
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResizeTimeout

Specifies a time-out period for the resizing operation. If the pool does not reach the target size by this time, the resize operation stops.

Type:TimeSpan
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False