Set-AzBatchJobSchedule
Sets a job schedule.
Syntax
Set-AzBatchJobSchedule
[-JobSchedule] <PSCloudJobSchedule>
-BatchContext <BatchAccountContext>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
The Set-AzBatchJobSchedule cmdlet sets a job schedule in the Azure Batch service.
Examples
Example 1: Update a job schedule
$JobSchedule = Get-AzBatchJobSchedule -Id "MyJobSchedule" -BatchContext $Context
$JobSchedule.Schedule.RecurrenceInterval = New-TimeSpan -Days 2
Set-AzBatchJobSchedule -JobSchedule $Job -BatchContext $ContextThe first command gets a job by using Get-AzBatchJobSchedule, and then stores it in the $JobSchedule variable.
The second command modifies the recurrence interval on the $JobSchedule.Schedule object.
The final command updates the Batch service to match the local object in $JobSchedule.
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 |
-JobSchedule
Specifies a PSCloudJobSchedule object that represents a job schedule. To obtain a PSCloudJobSchedule object, use the Get-AzBatchJobSchedule cmdlet.
| Type: | PSCloudJobSchedule |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |