New-​Azure​Batch​Job​Schedule

Creates a job schedule in the Batch service.

Syntax

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

Description

The New-AzureBatchJobSchedule 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

PS C:\>$Schedule = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSSchedule"
PS C:\> $Schedule.RecurrenceInterval = [TimeSpan]::FromDays(1)
PS C:\> $JobSpecification = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSJobSpecification"
PS C:\> $JobSpecification.PoolInformation = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSPoolInformation"
PS C:\> $JobSpecification.PoolInformation.PoolId = "ContosoPool06"
PS C:\> New-AzureBatchJobSchedule -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-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable.

Required Parameters

-BatchContext

Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.

Type:BatchAccountContext
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Id

Specifies the ID of the job schedule that this cmdlet creates.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
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
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
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-DisplayName

Specifies a display name for the job schedule.

Type:String
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False