Edit

Share via

New-AzureSchedulerJobCollection

  • Reference
Module:
Azure

Creates a scheduler job collection.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

New-AzureSchedulerJobCollection
   -Location <String>
   -JobCollectionName <String>
   [-Plan <String>]
   [-MaxJobCount <Int32>]
   [-Frequency <String>]
   [-Interval <Int32>]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Description

This topic describes the cmdlet in the 0.8.10 version of the Microsoft Azure PowerShell module. To get the version of the module you're using, in the Azure PowerShell console, type (Get-Module -Name Azure).Version.

The New-AzureSchedulerJobCollection cmdlet creates a scheduler job collection. If you do not specify a value for the Plan parameter, the cmdlet creates a standard job collection.

Examples

Example 1: Create a scheduler job collection that includes default values

PS C:\> New-AzureSchedulerJobCollection -JobCollectionName "JobCollection01" -Location "North Central US" -Plan "Standard"

This command creates a standard scheduler job collection named JobCollection01. The new collection has a default job count and maximum recurrence values for a standard scheduler job collection.

Example 2: Create a scheduler job collection with specified values

PS C:\> New-AzureSchedulerJobCollection -JobCollectionName "JobCollection02" -Location "North Central US" -Frequency "Hour" -Interval 12 -MaxJobCount 30 -Plan "Standard"

This command creates a standard scheduler job collection named JobCollection02. The new collection has a maximum job count of 30 and a maximum recurrence of 12 per hour.

Parameters

-Frequency

Specifies the maximum frequency that can be specified on any job in this scheduler job collection.

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

-Interval

Specifies the interval of recurrence at the frequency specified by using the Frequency parameter.

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

-JobCollectionName

Specifies the name for the new scheduler job collection.

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

-Location

Specifies the name of the location that hosts the cloud service. Valid values are:

  • Anywhere Asia
  • Anywhere Europe
  • Anywhere US
  • East Asia
  • East US
  • North Central US
  • North Europe
  • South Central US
  • Southeast Asia
  • West Europe
  • West US
Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-MaxJobCount

Specifies the maximum number of jobs that can be created in the scheduler job collection.

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

-Plan

Specifies the scheduler job collection plan.

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

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

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