Job Collections - Get

Gets a job collection.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}?api-version=2016-03-01

URI Parameters

Name In Required Type Description
jobCollectionName
path True
  • string

The job collection name.

resourceGroupName
path True
  • string

The resource group name.

subscriptionId
path True
  • string

The subscription id.

api-version
query True
  • string

The API version.

Responses

Name Type Description
200 OK

The job collection has been successfully returned.

Media Types: "application/json", "text/json"

Definitions

JobCollectionDefinition
JobCollectionProperties
JobCollectionQuota
JobCollectionState

Gets or sets the state.

JobMaxRecurrence
RecurrenceFrequency

Gets or sets the frequency of recurrence (minute, hour, day, week, month).

Sku
SkuDefinition

Gets or set the SKU.

JobCollectionDefinition

Name Type Description
id
  • string

Gets the job collection resource identifier.

location
  • string

Gets or sets the storage account location.

name
  • string

Gets or sets the job collection resource name.

properties

Gets or sets the job collection properties.

tags
  • object

Gets or sets the tags.

type
  • string

Gets the job collection resource type.

JobCollectionProperties

Name Type Description
quota

Gets or sets the job collection quota.

sku

Gets or sets the SKU.

state

Gets or sets the state.

JobCollectionQuota

Name Type Description
maxJobCount
  • integer

Gets or set the maximum job count.

maxJobOccurrence
  • integer

Gets or sets the maximum job occurrence.

maxRecurrence

Gets or set the maximum recurrence.

JobCollectionState

Gets or sets the state.

Name Type Description
Deleted
  • string
Disabled
  • string
Enabled
  • string
Suspended
  • string

JobMaxRecurrence

Name Type Description
frequency

Gets or sets the frequency of recurrence (second, minute, hour, day, week, month).

interval
  • integer

Gets or sets the interval between retries.

RecurrenceFrequency

Gets or sets the frequency of recurrence (minute, hour, day, week, month).

Name Type Description
Day
  • string
Hour
  • string
Minute
  • string
Month
  • string
Week
  • string

Sku

Name Type Description
name

Gets or set the SKU.

SkuDefinition

Gets or set the SKU.

Name Type Description
Free
  • string
P10Premium
  • string
P20Premium
  • string
Standard
  • string