Edit

Share via

New-AzBatchJobSchedule

  • Reference
Module:
Az.Batch

Creates a job schedule in the Batch service.

Syntax

New-AzBatchJobSchedule
   [-Id] <String>
   [-DisplayName <String>]
   -Schedule <PSSchedule>
   -JobSpecification <PSJobSpecification>
   [-Metadata <IDictionary>]
   -BatchContext <BatchAccountContext>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The New-AzBatchJobSchedule cmdlet creates a job schedule in the Azure Batch service. The BatchAccountContext parameter specifies the account in which this cmdlet creates the schedule.

Examples

Example 1: Create a job schedule

$Schedule = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSSchedule"
$Schedule.RecurrenceInterval = [TimeSpan]::FromDays(1)
$JobSpecification = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSJobSpecification"
$JobSpecification.PoolInformation = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSPoolInformation"
$JobSpecification.PoolInformation.PoolId = "ContosoPool06"
New-AzBatchJobSchedule -Id "JobSchedule17" -Schedule $Schedule -JobSpecification $JobSpecification -BatchContext $Context

This example creates a job schedule. The first five commands create and modify PSSchedule, PSJobSpecification, and PSPoolInformation objects. The commands use the New-Object cmdlet and standard Azure PowerShell syntax. The commands store these objects in the $Schedule and $JobSpecification variables. The final command creates a job schedule that has the ID JobSchedule17. This schedule creates jobs with a recurrence interval of one day. The jobs run on the pool that has the ID ContosoPool06, as specified in the fifth command. 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

-DisplayName

Specifies a display name for the job schedule.

Type:String
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 creates.

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

-JobSpecification

Specifies the details of the jobs that this cmdlet includes in the job schedule.

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

-Metadata

Specifies metadata, as key/value pairs, to add to the job schedule. The key is the metadata name. The value is the metadata value.

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

-Schedule

Specifies the schedule that determines when to create jobs.

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

Inputs

String

BatchAccountContext

Outputs

Void