Edit

Disable-AzBatchJobSchedule

  • Reference
Module:
Az.Batch

Disables a Batch job schedule.

Syntax

Disable-AzBatchJobSchedule
       [-Id] <String>
       -BatchContext <BatchAccountContext>
       [-DefaultProfile <IAzureContextContainer>]
       [<CommonParameters>]

Description

The Disable-AzBatchJobSchedule cmdlet disables an Azure Batch job schedule. If you disable a schedule, jobs are not created according to that schedule. You can enable a disabled schedule later.

Examples

Example 1: Disable a job schedule

Disable-AzBatchJobSchedule -Id "JobSchedule17" -BatchContext $Context

This command disables the job schedule that has the ID JobSchedule17. 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:BatchAccountContext
Position:Named
Default value:None
Required:True
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 job schedule that this cmdlet disables.

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

Inputs

String

BatchAccountContext

Outputs

Void