< Back
Restart-AzureBatchComputeNode
Post
NAME Restart-AzureBatchComputeNode
SYNOPSIS
Reboots the specified compute node.
SYNTAX
Restart-AzureBatchComputeNode [[-ComputeNode] <PSComputeNode>] [[-RebootOption] {Requeue | Terminate | TaskCompletion | RetainedData}]
-BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Restart-AzureBatchComputeNode [-PoolId] <String> [-Id] <String> [[-RebootOption] {Requeue | Terminate | TaskCompletion | RetainedData}]
-BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Restart-AzureBatchComputeNode cmdlet reboots the specified compute node.
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 to reboot.
Required? false
Position? 0
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 compute node to reboot.
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 node.
Required? true
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RebootOption <ComputeNodeRebootOption>
Specifies when to reboot the node and what to do with currently running tasks. The default is Requeue.
Required? false
Position? 2
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
PSComputeNode
Parameter 'ComputeNode' accepts value of type 'PSComputeNode' from the pipeline
OUTPUTS
NOTES
Example 1: Restart a compute node
PS C:\\>Restart-AzureBatchComputeNode -PoolId "MyPool" -Id "tvm-3257026573_2-20150813t200938z" -BatchContext $Context
This command reboots the compute node with the ID "tvm-3257026573_2-20150813t200938z" in the pool MyPool.
Example 2: Restart every compute node in a pool
PS C:\\>Get-AzureBatchComputeNode -PoolId "MyPool" -BatchContext $Context | Restart-AzureBatchComputeNode -BatchContext $Context
This command reboots every compute node in the pool MyPool.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... omputenode
Get-AzureBatchComputeNode
Reset-AzureBatchComputeNode
Azure Batch Cmdlets
SYNOPSIS
Reboots the specified compute node.
SYNTAX
Restart-AzureBatchComputeNode [[-ComputeNode] <PSComputeNode>] [[-RebootOption] {Requeue | Terminate | TaskCompletion | RetainedData}]
-BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Restart-AzureBatchComputeNode [-PoolId] <String> [-Id] <String> [[-RebootOption] {Requeue | Terminate | TaskCompletion | RetainedData}]
-BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Restart-AzureBatchComputeNode cmdlet reboots the specified compute node.
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 to reboot.
Required? false
Position? 0
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 compute node to reboot.
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 node.
Required? true
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RebootOption <ComputeNodeRebootOption>
Specifies when to reboot the node and what to do with currently running tasks. The default is Requeue.
Required? false
Position? 2
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
PSComputeNode
Parameter 'ComputeNode' accepts value of type 'PSComputeNode' from the pipeline
OUTPUTS
NOTES
Example 1: Restart a compute node
PS C:\\>Restart-AzureBatchComputeNode -PoolId "MyPool" -Id "tvm-3257026573_2-20150813t200938z" -BatchContext $Context
This command reboots the compute node with the ID "tvm-3257026573_2-20150813t200938z" in the pool MyPool.
Example 2: Restart every compute node in a pool
PS C:\\>Get-AzureBatchComputeNode -PoolId "MyPool" -BatchContext $Context | Restart-AzureBatchComputeNode -BatchContext $Context
This command reboots every compute node in the pool MyPool.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... omputenode
Get-AzureBatchComputeNode
Reset-AzureBatchComputeNode
Azure Batch Cmdlets