Skip to content

Latest commit

 

History

History
110 lines (78 loc) · 3.02 KB

Enable-AzBatchJob.md

File metadata and controls

110 lines (78 loc) · 3.02 KB
external help file Module Name ms.assetid online version schema
Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml
Az.Batch
7C79BFF1-41E1-472D-AF67-1C3B39AB7548
2.0.0

Enable-AzBatchJob

SYNOPSIS

Enables a Batch job.

SYNTAX

Enable-AzBatchJob [-Id] <String> -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

DESCRIPTION

The Enable-AzBatchJob cmdlet enables an Azure Batch job. After you enable a job, new tasks can run.

EXAMPLES

Example 1: Enable a Batch job

Enable-AzBatchJob -Id "Job-000001" -BatchContext $Context

This command enables the job that has the ID Job-000001. Use the Get-AzBatchAccountKey cmdlet to assign a context to the $Context variable.

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: Microsoft.Azure.Commands.Batch.BatchAccountContext
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-DefaultProfile

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

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id

Specifies the ID of the job that this cmdlet enables.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.String

Microsoft.Azure.Commands.Batch.BatchAccountContext

OUTPUTS

System.Void

NOTES

RELATED LINKS

Disable-AzBatchJob

Get-AzBatchJob

New-AzBatchJob

Remove-AzBatchJob

Stop-AzBatchJob

Azure Batch Cmdlets