< Back
New-AzureBatchJobSchedule
Post
NAME New-AzureBatchJobSchedule
SYNOPSIS
Creates a job schedule in the Batch service.
SYNTAX
New-AzureBatchJobSchedule [-Id] <String> -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-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.
PARAMETERS
-BatchContext <BatchAccountContext>
Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. If you use the Get-AzureRmBatchAccount
cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To
use shared key authentication instead, use the Get-AzureRmBatchAccountKeys 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.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DisplayName <String>
Specifies a display name for the job schedule.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Id <String>
Specifies the ID of the job schedule that this cmdlet creates.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-JobSpecification <PSJobSpecification>
Specifies the details of the jobs that this cmdlet includes in the job schedule.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Metadata <IDictionary>
Specifies metadata, as key/value pairs, to add to the job schedule. The key is the metadata name. The value is the metadata value.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Schedule <PSSchedule>
Specifies the schedule that determines when to create jobs.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
BatchAccountContext
Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline
OUTPUTS
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... obschedule
Disable-AzureBatchJobSchedule
Enable-AzureBatchJobSchedule
Get-AzureRmBatchAccountKeys
Get-AzureBatchJobSchedule
Remove-AzureBatchJobSchedule
Stop-AzureBatchJobSchedule
Azure Batch Cmdlets
SYNOPSIS
Creates a job schedule in the Batch service.
SYNTAX
New-AzureBatchJobSchedule [-Id] <String> -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-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.
PARAMETERS
-BatchContext <BatchAccountContext>
Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. If you use the Get-AzureRmBatchAccount
cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To
use shared key authentication instead, use the Get-AzureRmBatchAccountKeys 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.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DisplayName <String>
Specifies a display name for the job schedule.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Id <String>
Specifies the ID of the job schedule that this cmdlet creates.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-JobSpecification <PSJobSpecification>
Specifies the details of the jobs that this cmdlet includes in the job schedule.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Metadata <IDictionary>
Specifies metadata, as key/value pairs, to add to the job schedule. The key is the metadata name. The value is the metadata value.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Schedule <PSSchedule>
Specifies the schedule that determines when to create jobs.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
BatchAccountContext
Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline
OUTPUTS
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... obschedule
Disable-AzureBatchJobSchedule
Enable-AzureBatchJobSchedule
Get-AzureRmBatchAccountKeys
Get-AzureBatchJobSchedule
Remove-AzureBatchJobSchedule
Stop-AzureBatchJobSchedule
Azure Batch Cmdlets