Edit

Share via

Restart-AzureBatchComputeNode

  • Reference
Module:
AzureRM.Batch

Reboots the specified compute node.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Restart-AzureBatchComputeNode
       [-PoolId] <String>
       [-Id] <String>
       [[-RebootOption] <ComputeNodeRebootOption>]
       -BatchContext <BatchAccountContext>
       [-DefaultProfile <IAzureContextContainer>]
       [<CommonParameters>]
Restart-AzureBatchComputeNode
       [[-ComputeNode] <PSComputeNode>]
       [[-RebootOption] <ComputeNodeRebootOption>]
       -BatchContext <BatchAccountContext>
       [-DefaultProfile <IAzureContextContainer>]
       [<CommonParameters>]

Description

The Restart-AzureBatchComputeNode cmdlet reboots the specified compute node.

Examples

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.

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 Microsoft Entra 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:BatchAccountContext
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ComputeNode

Specifies the PSComputeNode object that represents the compute node to reboot.

Type:PSComputeNode
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Id

Specifies the ID of the compute node to reboot.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-PoolId

Specifies the ID of the pool that contains the compute node.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-RebootOption

Specifies when to reboot the node and what to do with currently running tasks. The default is Requeue.

Type:Nullable<T>[ComputeNodeRebootOption]
Accepted values:Requeue, Terminate, TaskCompletion, RetainedData
Position:2
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

PSComputeNode

Parameters: ComputeNode (ByValue)

BatchAccountContext

Parameters: BatchContext (ByValue)

Outputs

Void