< Back
Stop-AzureBatchPoolResize
Post
NAME Stop-AzureBatchPoolResize
SYNOPSIS
Stops a pool resize operation.
SYNTAX
Stop-AzureBatchPoolResize [-Id] <String> -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Stop-AzureBatchPoolResize cmdlet stops 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
-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 for which this cmdlet stops a resizing operation.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
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: Stop resizing a pool
PS C:\\>Stop-AzureBatchPoolResize -Id "ContosoPool06" -BatchContext $Context
This command stops a resize operation on the pool that has the ID ContosoPool06. Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to
the $Context variable.
Example 2: Stop resizing a pool by using the pipeline
PS C:\\>Get-AzureBatchPool -Id "ContosoPool06" -BatchContext $Context | Stop-AzureBatchPoolResize -BatchContext $Context
This command stops resizing a pool by using the pipeline operator. 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. The command stops the resize operation on that pool.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... poolresize
Get-AzureRmBatchAccountKeys
Get-AzureBatchPool
Start-AzureBatchPoolResize
Azure Batch Cmdlets
SYNOPSIS
Stops a pool resize operation.
SYNTAX
Stop-AzureBatchPoolResize [-Id] <String> -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Stop-AzureBatchPoolResize cmdlet stops 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
-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 for which this cmdlet stops a resizing operation.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
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: Stop resizing a pool
PS C:\\>Stop-AzureBatchPoolResize -Id "ContosoPool06" -BatchContext $Context
This command stops a resize operation on the pool that has the ID ContosoPool06. Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to
the $Context variable.
Example 2: Stop resizing a pool by using the pipeline
PS C:\\>Get-AzureBatchPool -Id "ContosoPool06" -BatchContext $Context | Stop-AzureBatchPoolResize -BatchContext $Context
This command stops resizing a pool by using the pipeline operator. 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. The command stops the resize operation on that pool.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... poolresize
Get-AzureRmBatchAccountKeys
Get-AzureBatchPool
Start-AzureBatchPoolResize
Azure Batch Cmdlets