Start-AzureBatchPoolResize

Starts to resize a pool.

Syntax

Start-AzureBatchPoolResize
     [-Id] <String>
     [-TargetDedicatedComputeNodes <Int32>]
     [-TargetLowPriorityComputeNodes <Int32>]
     [-ResizeTimeout <TimeSpan>]
     [-ComputeNodeDeallocationOption <ComputeNodeDeallocationOption>]
     -BatchContext <BatchAccountContext>
     [-DefaultProfile <IAzureContextContainer>]
     [<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" -TargetDedicatedComputeNodes 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 -TargetDedicatedComputeNodes 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. If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property.

Type:Microsoft.Azure.Commands.Batch.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

Optional Parameters

-ComputeNodeDeallocationOption

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

Type:System.Nullable`1[Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption]
Parameter Sets:Requeue, Terminate, TaskCompletion, RetainedData
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
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:System.Nullable`1[System.TimeSpan]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-TargetDedicatedComputeNodes

The number of target dedicated compute nodes.

Type:System.Nullable`1[System.Int32]
Aliases:TargetDedicated
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-TargetLowPriorityComputeNodes

The number of target low-priority compute nodes.

Type:System.Nullable`1[System.Int32]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

BatchAccountContext

Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline

Inputs

String

Parameter 'Id' accepts value of type 'String' from the pipeline