Reset-AzBatchComputeNode
Reinstalls the operating system on the specified compute node.
Syntax
Reset-AzBatchComputeNode
[-PoolId] <String>
[-Id] <String>
[-ReimageOption <ComputeNodeReimageOption>]
-BatchContext <BatchAccountContext>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Reset-AzBatchComputeNode
[[-ComputeNode] <PSComputeNode>]
[-ReimageOption <ComputeNodeReimageOption>]
-BatchContext <BatchAccountContext>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Reset-AzBatchComputeNode cmdlet reinstalls the operating system on the specified compute node.
Examples
Example 1: Reimage a node
Reset-AzBatchComputeNode -PoolId "MyPool" -Id "tvm-3257026573_2-20150813t200938z" -BatchContext $Context
This command reimages the compute node with ID "tvm-3257026573_2-20150813t200938z" in the pool named MyPool. Use the Get-AzBatchAccountKey cmdlet to assign a context to the $Context variable.
Example 2: Reimage all nodes in a pool
Get-AzBatchComputeNode -PoolId "MyPool" -BatchContext $Context | Reset-AzBatchComputeNode -BatchContext $Context
This command reimages every compute node in the pool named MyPool.
Parameters
-BatchContext
Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. If you use the Get-AzBatchAccount 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-AzBatchAccountKey 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 reimage.
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: | AzContext, 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 reimage.
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 |
-ReimageOption
Specifies when to reimage the node and what to do with currently running tasks. The default is Requeue.
Type: | Nullable<T>[ComputeNodeReimageOption] |
Accepted values: | Requeue, Terminate, TaskCompletion, RetainedData |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |