< Back
Remove-AzureBatchComputeNode
Post
NAME Remove-AzureBatchComputeNode
SYNOPSIS
Removes compute nodes from a pool.
SYNTAX
Remove-AzureBatchComputeNode [[-ComputeNode] <PSComputeNode>] -BatchContext <BatchAccountContext> [-DeallocationOption {Requeue | Terminate |
TaskCompletion | RetainedData}] [-DefaultProfile <IAzureContextContainer>] [-Force] [-ResizeTimeout <TimeSpan>] [-Confirm] [-WhatIf]
[<CommonParameters>]
Remove-AzureBatchComputeNode [-PoolId] <String> [-Ids] <String[]> -BatchContext <BatchAccountContext> [-DeallocationOption {Requeue | Terminate |
TaskCompletion | RetainedData}] [-DefaultProfile <IAzureContextContainer>] [-Force] [-ResizeTimeout <TimeSpan>] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
The Remove-AzureBatchComputeNode cmdlet removes Azure Batch compute nodes from 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
-ComputeNode <PSComputeNode>
Specifies the PSComputeNode object that represents the compute node that this cmdlet removes.
Required? false
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-DeallocationOption <ComputeNodeDeallocationOption>
Specifies a deallocation option for the removal operation that this cmdlet starts. The default value is Requeue.
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
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Ids <String[]>
Specifies an array of IDs of compute nodes that this cmdlet removes from the pool.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PoolId <String>
Specifies the ID of the pool that contains the compute nodes that this cmdlet removes.
Required? true
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ResizeTimeout <TimeSpan>
Specifies the time-out interval for removal of the compute nodes from the pool. The default value is 10 minutes. The minimum value is 5
minutes.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
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
PSComputeNode
Parameter 'ComputeNode' accepts value of type 'PSComputeNode' from the pipeline
OUTPUTS
NOTES
Example 1: Remove a compute node
PS C:\\>Remove-AzureBatchComputeNode -PoolId "Pool07" -Ids "tvm-2316545714_1-20150725t213220z" -DeallocationOption Terminate -ResizeTimeout
([TimeSpan]::FromMinutes(10)) -BatchContext $Context
This command removes compute node that has the specified ID from pool that has the ID Pool07. The command specifies the Terminate deallocation
option. The resize time-out is of 10 minutes.
Example 2: Remove a compute node by using the pipeline
PS C:\\>Get-AzureBatchComputeNode -PoolId "Pool07" -Id "tvm-2316545714_1-20150725t213220z" -BatchContext $Context | Remove-AzureBatchComputeNode
-Force -BatchContext $Context
This command gets the compute node that has the specified ID from pool that has the ID Pool07 by using the Get-AzureBatchComputeNode cmdlet. The
command passes that node to the current cmdlet by using the pipeline. The current cmdlet removes the compute node. The command specifies the Force
parameter. Therefore, the command does not prompt you for confirmation.
Example 3: Remove multiple nodes
PS C:\\>Remove-AzureBatchComputeNode -PoolId "Pool07" @("tvm-1783593343_28-20151117t214257z","tvm-1783593343_29-20151117t214257z") -Force
-BatchContext $Context
This command removes two compute nodes from the pool that has the ID Pool07. The command does not prompt you for confirmation.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... omputenode
Get-AzureRmBatchAccountKeys
Get-AzureBatchComputeNode
Restart-AzureBatchComputeNode
SYNOPSIS
Removes compute nodes from a pool.
SYNTAX
Remove-AzureBatchComputeNode [[-ComputeNode] <PSComputeNode>] -BatchContext <BatchAccountContext> [-DeallocationOption {Requeue | Terminate |
TaskCompletion | RetainedData}] [-DefaultProfile <IAzureContextContainer>] [-Force] [-ResizeTimeout <TimeSpan>] [-Confirm] [-WhatIf]
[<CommonParameters>]
Remove-AzureBatchComputeNode [-PoolId] <String> [-Ids] <String[]> -BatchContext <BatchAccountContext> [-DeallocationOption {Requeue | Terminate |
TaskCompletion | RetainedData}] [-DefaultProfile <IAzureContextContainer>] [-Force] [-ResizeTimeout <TimeSpan>] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
The Remove-AzureBatchComputeNode cmdlet removes Azure Batch compute nodes from 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
-ComputeNode <PSComputeNode>
Specifies the PSComputeNode object that represents the compute node that this cmdlet removes.
Required? false
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-DeallocationOption <ComputeNodeDeallocationOption>
Specifies a deallocation option for the removal operation that this cmdlet starts. The default value is Requeue.
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
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Ids <String[]>
Specifies an array of IDs of compute nodes that this cmdlet removes from the pool.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PoolId <String>
Specifies the ID of the pool that contains the compute nodes that this cmdlet removes.
Required? true
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ResizeTimeout <TimeSpan>
Specifies the time-out interval for removal of the compute nodes from the pool. The default value is 10 minutes. The minimum value is 5
minutes.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
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
PSComputeNode
Parameter 'ComputeNode' accepts value of type 'PSComputeNode' from the pipeline
OUTPUTS
NOTES
Example 1: Remove a compute node
PS C:\\>Remove-AzureBatchComputeNode -PoolId "Pool07" -Ids "tvm-2316545714_1-20150725t213220z" -DeallocationOption Terminate -ResizeTimeout
([TimeSpan]::FromMinutes(10)) -BatchContext $Context
This command removes compute node that has the specified ID from pool that has the ID Pool07. The command specifies the Terminate deallocation
option. The resize time-out is of 10 minutes.
Example 2: Remove a compute node by using the pipeline
PS C:\\>Get-AzureBatchComputeNode -PoolId "Pool07" -Id "tvm-2316545714_1-20150725t213220z" -BatchContext $Context | Remove-AzureBatchComputeNode
-Force -BatchContext $Context
This command gets the compute node that has the specified ID from pool that has the ID Pool07 by using the Get-AzureBatchComputeNode cmdlet. The
command passes that node to the current cmdlet by using the pipeline. The current cmdlet removes the compute node. The command specifies the Force
parameter. Therefore, the command does not prompt you for confirmation.
Example 3: Remove multiple nodes
PS C:\\>Remove-AzureBatchComputeNode -PoolId "Pool07" @("tvm-1783593343_28-20151117t214257z","tvm-1783593343_29-20151117t214257z") -Force
-BatchContext $Context
This command removes two compute nodes from the pool that has the ID Pool07. The command does not prompt you for confirmation.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... omputenode
Get-AzureRmBatchAccountKeys
Get-AzureBatchComputeNode
Restart-AzureBatchComputeNode