New-AzureRmSchedulerJobCollection

Creates a job collection.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

New-AzureRmSchedulerJobCollection
   -ResourceGroupName <String>
   -JobCollectionName <String>
   -Location <String>
   [-Plan <String>]
   [-MaxJobCount <Int32>]
   [-Frequency <String>]
   [-Interval <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-AzureRmSchedulerJobCollection cmdlet creates a job collection in Azure Scheduler.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Frequency

Specifies the maximum frequency that you can specify on any job in the job collection. The acceptable values for this parameter are:

  • Minute
  • Hour
  • Day
  • Week
  • Month
Type:String
Accepted values:Minute, Hour, Day, Week, Month
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Interval

Specifies an interval of recurrence.

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-JobCollectionName

Specifies a name for the job collection.

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

-Location

Specifies the Azure region in which this cmdlet creates the job collection.

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

-MaxJobCount

Specifies the maximum number of jobs that you can create in the job collection. The maximum depends on the plan that the Plan parameter specifies.

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Plan

Specifies the job collection plan. The acceptable values for this parameter are:

  • Free
  • Standard
  • P10Premium
  • P20Premium
Type:String
Accepted values:Free, Standard, P10Premium, P20Premium
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

Specifies the resource group for the job collection.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

Outputs

PSJobCollectionDefinition