< Back
Start-AzureBatchPoolResize
Post
NAME Start-AzureBatchPoolResize
SYNOPSIS
Starts to resize a pool.
SYNTAX
Start-AzureBatchPoolResize [-Id] <String> -BatchContext <BatchAccountContext> [-ComputeNodeDeallocationOption {Requeue | Terminate |
TaskCompletion | RetainedData}] [-DefaultProfile <IAzureContextContainer>] [-ResizeTimeout <TimeSpan>] [-TargetDedicatedComputeNodes <Int32>]
[-TargetLowPriorityComputeNodes <Int32>] [<CommonParameters>]
DESCRIPTION
The Start-AzureBatchPoolResize cmdlet starts an Azure Batch resize operation on a pool.
PARAMETERS
-BatchContext <BatchAccountContext>
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.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-ComputeNodeDeallocationOption <ComputeNodeDeallocationOption>
Specifies a deallocation option for the resizing operation that this cmdlet starts.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Id <String>
Specifies the ID of the pool that this cmdlet resizes.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-ResizeTimeout <TimeSpan>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-TargetDedicatedComputeNodes <Int32>
The number of target dedicated compute nodes.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-TargetLowPriorityComputeNodes <Int32>
The number of target low-priority compute nodes.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
BatchAccountContext
Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline
String
Parameter 'Id' accepts value of type 'String' from the pipeline
OUTPUTS
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... poolresize
Get-AzureRmBatchAccountKeys
Get-AzureBatchPool
Stop-AzureBatchPoolResize
Azure Batch Cmdlets
SYNOPSIS
Starts to resize a pool.
SYNTAX
Start-AzureBatchPoolResize [-Id] <String> -BatchContext <BatchAccountContext> [-ComputeNodeDeallocationOption {Requeue | Terminate |
TaskCompletion | RetainedData}] [-DefaultProfile <IAzureContextContainer>] [-ResizeTimeout <TimeSpan>] [-TargetDedicatedComputeNodes <Int32>]
[-TargetLowPriorityComputeNodes <Int32>] [<CommonParameters>]
DESCRIPTION
The Start-AzureBatchPoolResize cmdlet starts an Azure Batch resize operation on a pool.
PARAMETERS
-BatchContext <BatchAccountContext>
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.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-ComputeNodeDeallocationOption <ComputeNodeDeallocationOption>
Specifies a deallocation option for the resizing operation that this cmdlet starts.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Id <String>
Specifies the ID of the pool that this cmdlet resizes.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-ResizeTimeout <TimeSpan>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-TargetDedicatedComputeNodes <Int32>
The number of target dedicated compute nodes.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-TargetLowPriorityComputeNodes <Int32>
The number of target low-priority compute nodes.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
BatchAccountContext
Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline
String
Parameter 'Id' accepts value of type 'String' from the pipeline
OUTPUTS
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... poolresize
Get-AzureRmBatchAccountKeys
Get-AzureBatchPool
Stop-AzureBatchPoolResize
Azure Batch Cmdlets