external help file | Module Name | ms.assetid | online version | schema |
---|---|---|---|---|
Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml |
Az.Batch |
B4737AE8-F57C-4B95-B81E-74802EF8E7AE |
2.0.0 |
Disables a Batch job schedule.
Disable-AzBatchJobSchedule [-Id] <String> -BatchContext <BatchAccountContext>
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
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.
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.
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
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
Specifies the ID of the job schedule that this cmdlet disables.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.