Edit

Share via

Get-AzureSchedulerJob

  • Reference
Module:
Azure

Gets a list of scheduler jobs or a particular scheduler job.

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

Get-AzureSchedulerJob
   -Location <String>
   -JobCollectionName <String>
   [-JobName <String>]
   [-JobState <String>]
   [-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 Get-AzureSchedulerJobCollection cmdlet gets a list of scheduler jobs or a particular scheduler job.

Examples

Example 1: Get all jobs in a collection

PS C:\> Get-AzureSchedulerJob -Location "North Central US" -JobCollectionName "JobCollection01"

This command gets scheduler jobs that are part of the job collection named JobCollection01.

Example 2: Get a named job

PS C:\> Get-AzureSchedulerJob -Location "North Central US" -JobCollectionName "JobCollection01" -JobName "Job01"

This command gets the job named Job01 from the collection named JobCollection01 in the specified location.

Example 3: Get disabled jobs in a collection

PS C:\> Get-AzureSchedulerJobCollection -Location "North Central US" -JobCollectionName "JobCollection01" -JobState "Disabled"

This command gets all disabled scheduler jobs that are part of JobCollection01 in the specified location.

Parameters

-JobCollectionName

Specifies the name of the collection that contains the scheduler job to get.

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

-JobName

Specifies the name of a scheduler job to get.

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

-JobState

Specifies the state of scheduler jobs to get. The acceptable values for this parameter are:

  • Enabled
  • Disabled
  • Faulted
  • Completed
Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Location

Specifies the name of the location that hosts the cloud service. The acceptable values for this parameter 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: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