Enable-AzBatchTask

Reference

Module:: Az.Batch

Reactivates a task.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Enable-AzBatchTask
      [-JobId] <String>
      [-Id] <String>
      -BatchContext <BatchAccountContext>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Enable-AzBatchTask
      [-Task] <PSCloudTask>
      -BatchContext <BatchAccountContext>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Enable-AzBatchTask cmdlet reactivates a task. If a task has exhausted its retry count, this cmdlet nevertheless enables it to run.

Examples

Example 1: Reactivate a task

PS C:\>Enable-AzBatchTask -JobId "Job7" -Id "Task2" -BatchContext $Context

This command reactivates the task Task2 in job Job7.

Example 2: Reactivate a task by using the pipeline

PS C:\>Get-AzBatchTask -JobId "Job8" -Id "Task3" -BatchContext $Context | Enable-AzBatchTask -BatchContext $Context

This command gets the Batch task that has the ID Task3 in the job that has the ID Job8 by using the Get-AzBatchTask cmdlet. The command passes that task to the current cmdlet by using the pipeline operator. The command reactivates that task.

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 Azure Active Directory 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
Accept pipeline input:	True
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Accept pipeline input:	False
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
Accept pipeline input:	False
Accept wildcard characters:	False

-Id

Specifies the ID of the task to reactivate.

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

-JobId

Specifies the ID of the job that contains the task.

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

-Task

Specifies the task that this cmdlet reactivates. To obtain a PSCloudTask object, use the Get-AzBatchTask cmdlet.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String

PSCloudTask

BatchAccountContext

Outputs

Void