Microsoft.Scheduler (stable:2016-03-01)

2025/09/19 • 15 new, 15 deleted methods

JobCollections_ListBySubscription (new)
Description :  Gets all job collections under specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Scheduler/jobCollections
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the job collections. ,
Required: False ,
}
[
{
id:
{
Description: Gets the job collection resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job collection resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the job collection resource name. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the storage account location. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets the tags. ,
Required: False ,
}
object ,
properties:
{
Description: Gets or sets the job collection properties. ,
Required: False ,
}
{
sku:
{
Description: Gets or sets the SKU. ,
Required: False ,
}
{
name:
{
Description: Gets or set the SKU. ,
Enum:
{
Standard: No description available. ,
Free: No description available. ,
P10Premium: No description available. ,
P20Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
state:
{
Description: Gets or sets the state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
quota:
{
Description: Gets or sets the job collection quota. ,
Required: False ,
}
{
maxJobCount:
{
Description: Gets or set the maximum job count. ,
Required: False ,
}
integer ,
maxJobOccurrence:
{
Description: Gets or sets the maximum job occurrence. ,
Required: False ,
}
integer ,
maxRecurrence:
{
Description: Gets or set the maximum recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets the URL to get the next set of job collections. ,
Required: False ,
}
string ,
}
JobCollections_ListByResourceGroup (new)
Description :  Gets all job collections under specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the job collections. ,
Required: False ,
}
[
{
id:
{
Description: Gets the job collection resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job collection resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the job collection resource name. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the storage account location. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets the tags. ,
Required: False ,
}
object ,
properties:
{
Description: Gets or sets the job collection properties. ,
Required: False ,
}
{
sku:
{
Description: Gets or sets the SKU. ,
Required: False ,
}
{
name:
{
Description: Gets or set the SKU. ,
Enum:
{
Standard: No description available. ,
Free: No description available. ,
P10Premium: No description available. ,
P20Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
state:
{
Description: Gets or sets the state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
quota:
{
Description: Gets or sets the job collection quota. ,
Required: False ,
}
{
maxJobCount:
{
Description: Gets or set the maximum job count. ,
Required: False ,
}
integer ,
maxJobOccurrence:
{
Description: Gets or sets the maximum job occurrence. ,
Required: False ,
}
integer ,
maxRecurrence:
{
Description: Gets or set the maximum recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets the URL to get the next set of job collections. ,
Required: False ,
}
string ,
}
JobCollections_Get (new)
Description :  Gets a job collection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
jobCollectionName:
{
Description: The job collection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets the job collection resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job collection resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the job collection resource name. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the storage account location. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets the tags. ,
Required: False ,
}
object ,
properties:
{
Description: Gets or sets the job collection properties. ,
Required: False ,
}
{
sku:
{
Description: Gets or sets the SKU. ,
Required: False ,
}
{
name:
{
Description: Gets or set the SKU. ,
Enum:
{
Standard: No description available. ,
Free: No description available. ,
P10Premium: No description available. ,
P20Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
state:
{
Description: Gets or sets the state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
quota:
{
Description: Gets or sets the job collection quota. ,
Required: False ,
}
{
maxJobCount:
{
Description: Gets or set the maximum job count. ,
Required: False ,
}
integer ,
maxJobOccurrence:
{
Description: Gets or sets the maximum job occurrence. ,
Required: False ,
}
integer ,
maxRecurrence:
{
Description: Gets or set the maximum recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
JobCollections_CreateOrUpdate (new)
Description :  Provisions a new job collection or updates an existing job collection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
jobCollectionName:
{
Description: The job collection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
jobCollection:
{
Description: The job collection definition. ,
Required: True ,
}
{
id:
{
Description: Gets the job collection resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job collection resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the job collection resource name. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the storage account location. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets the tags. ,
Required: False ,
}
object ,
properties:
{
Description: Gets or sets the job collection properties. ,
Required: False ,
}
{
sku:
{
Description: Gets or sets the SKU. ,
Required: False ,
}
{
name:
{
Description: Gets or set the SKU. ,
Enum:
{
Standard: No description available. ,
Free: No description available. ,
P10Premium: No description available. ,
P20Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
state:
{
Description: Gets or sets the state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
quota:
{
Description: Gets or sets the job collection quota. ,
Required: False ,
}
{
maxJobCount:
{
Description: Gets or set the maximum job count. ,
Required: False ,
}
integer ,
maxJobOccurrence:
{
Description: Gets or sets the maximum job occurrence. ,
Required: False ,
}
integer ,
maxRecurrence:
{
Description: Gets or set the maximum recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Gets the job collection resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job collection resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the job collection resource name. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the storage account location. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets the tags. ,
Required: False ,
}
object ,
properties:
{
Description: Gets or sets the job collection properties. ,
Required: False ,
}
{
sku:
{
Description: Gets or sets the SKU. ,
Required: False ,
}
{
name:
{
Description: Gets or set the SKU. ,
Enum:
{
Standard: No description available. ,
Free: No description available. ,
P10Premium: No description available. ,
P20Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
state:
{
Description: Gets or sets the state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
quota:
{
Description: Gets or sets the job collection quota. ,
Required: False ,
}
{
maxJobCount:
{
Description: Gets or set the maximum job count. ,
Required: False ,
}
integer ,
maxJobOccurrence:
{
Description: Gets or sets the maximum job occurrence. ,
Required: False ,
}
integer ,
maxRecurrence:
{
Description: Gets or set the maximum recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}

⚐ Response (201)

{
id:
{
Description: Gets the job collection resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job collection resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the job collection resource name. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the storage account location. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets the tags. ,
Required: False ,
}
object ,
properties:
{
Description: Gets or sets the job collection properties. ,
Required: False ,
}
{
sku:
{
Description: Gets or sets the SKU. ,
Required: False ,
}
{
name:
{
Description: Gets or set the SKU. ,
Enum:
{
Standard: No description available. ,
Free: No description available. ,
P10Premium: No description available. ,
P20Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
state:
{
Description: Gets or sets the state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
quota:
{
Description: Gets or sets the job collection quota. ,
Required: False ,
}
{
maxJobCount:
{
Description: Gets or set the maximum job count. ,
Required: False ,
}
integer ,
maxJobOccurrence:
{
Description: Gets or sets the maximum job occurrence. ,
Required: False ,
}
integer ,
maxRecurrence:
{
Description: Gets or set the maximum recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
JobCollections_Patch (new)
Description :  Patches an existing job collection.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
jobCollectionName:
{
Description: The job collection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
jobCollection:
{
Description: The job collection definition. ,
Required: True ,
}
{
id:
{
Description: Gets the job collection resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job collection resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the job collection resource name. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the storage account location. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets the tags. ,
Required: False ,
}
object ,
properties:
{
Description: Gets or sets the job collection properties. ,
Required: False ,
}
{
sku:
{
Description: Gets or sets the SKU. ,
Required: False ,
}
{
name:
{
Description: Gets or set the SKU. ,
Enum:
{
Standard: No description available. ,
Free: No description available. ,
P10Premium: No description available. ,
P20Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
state:
{
Description: Gets or sets the state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
quota:
{
Description: Gets or sets the job collection quota. ,
Required: False ,
}
{
maxJobCount:
{
Description: Gets or set the maximum job count. ,
Required: False ,
}
integer ,
maxJobOccurrence:
{
Description: Gets or sets the maximum job occurrence. ,
Required: False ,
}
integer ,
maxRecurrence:
{
Description: Gets or set the maximum recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Gets the job collection resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job collection resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the job collection resource name. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the storage account location. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets the tags. ,
Required: False ,
}
object ,
properties:
{
Description: Gets or sets the job collection properties. ,
Required: False ,
}
{
sku:
{
Description: Gets or sets the SKU. ,
Required: False ,
}
{
name:
{
Description: Gets or set the SKU. ,
Enum:
{
Standard: No description available. ,
Free: No description available. ,
P10Premium: No description available. ,
P20Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
state:
{
Description: Gets or sets the state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
quota:
{
Description: Gets or sets the job collection quota. ,
Required: False ,
}
{
maxJobCount:
{
Description: Gets or set the maximum job count. ,
Required: False ,
}
integer ,
maxJobOccurrence:
{
Description: Gets or sets the maximum job occurrence. ,
Required: False ,
}
integer ,
maxRecurrence:
{
Description: Gets or set the maximum recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
JobCollections_Delete (new)
Description :  Deletes a job collection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
jobCollectionName:
{
Description: The job collection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
JobCollections_Enable (new)
Description :  Enables all of the jobs in the job collection.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/enable
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
jobCollectionName:
{
Description: The job collection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
JobCollections_Disable (new)
Description :  Disables all of the jobs in the job collection.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/disable
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
jobCollectionName:
{
Description: The job collection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
Jobs_Get (new)
Description :  Gets a job.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
jobCollectionName:
{
Description: The job collection name. ,
Required: True ,
}
string ,
jobName:
{
Description: The job name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets the job resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets the job resource name. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the job properties. ,
Required: False ,
}
{
startTime:
{
Description: Gets or sets the job start time. ,
Format: date-time ,
Required: False ,
}
string ,
action:
{
Description: Gets or sets the job action. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the job action type. ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
StorageQueue: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
}
,
Required: False ,
}
enum ,
request:
{
Description: Gets or sets the http requests. ,
Required: False ,
}
{
authentication:
{
Description: Gets or sets the authentication method of the request. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the HTTP authentication type. ,
Enum:
{
NotSpecified: No description available. ,
ClientCertificate: No description available. ,
ActiveDirectoryOAuth: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
uri:
{
Description: Gets or sets the URI of the request. ,
Required: False ,
}
string ,
method:
{
Description: Gets or sets the method of the request. ,
Required: False ,
}
string ,
body:
{
Description: Gets or sets the request body. ,
Required: False ,
}
string ,
headers:
{
Description: Gets or sets the headers. ,
Required: False ,
}
object ,
}
,
queueMessage:
{
Description: Gets or sets the storage queue message. ,
Required: False ,
}
{
storageAccount:
{
Description: Gets or sets the storage account name. ,
Required: False ,
}
string ,
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
sasToken:
{
Description: Gets or sets the SAS key. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message. ,
Required: False ,
}
string ,
}
,
serviceBusQueueMessage:
{
Description: Gets or sets the service bus queue message. ,
Required: False ,
}
{
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
}
,
serviceBusTopicMessage:
{
Description: Gets or sets the service bus topic message. ,
Required: False ,
}
{
topicPath:
{
Description: Gets or sets the topic path. ,
Required: False ,
}
string ,
}
,
retryPolicy:
{
Description: Gets or sets the retry policy. ,
Required: False ,
}
{
retryType:
{
Description: Gets or sets the retry strategy to be used. ,
Enum:
{
None: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
retryInterval:
{
Description: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets or sets the number of times a retry should be attempted. ,
Required: False ,
}
integer ,
}
,
errorAction:
{
Description: Gets or sets the error action. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the job error action type. ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
StorageQueue: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
}
,
Required: False ,
}
enum ,
request:
{
Description: Gets or sets the http requests. ,
Required: False ,
}
{
authentication:
{
Description: Gets or sets the authentication method of the request. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the HTTP authentication type. ,
Enum:
{
NotSpecified: No description available. ,
ClientCertificate: No description available. ,
ActiveDirectoryOAuth: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
uri:
{
Description: Gets or sets the URI of the request. ,
Required: False ,
}
string ,
method:
{
Description: Gets or sets the method of the request. ,
Required: False ,
}
string ,
body:
{
Description: Gets or sets the request body. ,
Required: False ,
}
string ,
headers:
{
Description: Gets or sets the headers. ,
Required: False ,
}
object ,
}
,
queueMessage:
{
Description: Gets or sets the storage queue message. ,
Required: False ,
}
{
storageAccount:
{
Description: Gets or sets the storage account name. ,
Required: False ,
}
string ,
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
sasToken:
{
Description: Gets or sets the SAS key. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message. ,
Required: False ,
}
string ,
}
,
serviceBusQueueMessage:
{
Description: Gets or sets the service bus queue message. ,
Required: False ,
}
{
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
}
,
serviceBusTopicMessage:
{
Description: Gets or sets the service bus topic message. ,
Required: False ,
}
{
topicPath:
{
Description: Gets or sets the topic path. ,
Required: False ,
}
string ,
}
,
retryPolicy:
{
Description: Gets or sets the retry policy. ,
Required: False ,
}
{
retryType:
{
Description: Gets or sets the retry strategy to be used. ,
Enum:
{
None: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
retryInterval:
{
Description: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets or sets the number of times a retry should be attempted. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
recurrence:
{
Description: Gets or sets the job recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
count:
{
Description: Gets or sets the maximum number of times that the job should run. ,
Required: False ,
}
integer ,
endTime:
{
Description: Gets or sets the time at which the job will complete. ,
Format: date-time ,
Required: False ,
}
string ,
schedule:
{
Required: False ,
}
{
weekDays:
{
Description: Gets or sets the days of the week that the job should execute on. ,
Required: False ,
}
[
string ,
]
,
hours:
{
Description: Gets or sets the hours of the day that the job should execute at. ,
Required: False ,
}
[
integer ,
]
,
minutes:
{
Description: Gets or sets the minutes of the hour that the job should execute at. ,
Required: False ,
}
[
integer ,
]
,
monthDays:
{
Description: Gets or sets the days of the month that the job should execute on. Must be between 1 and 31. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: Gets or sets the occurrences of days within a month. ,
Required: False ,
}
[
{
day:
{
Description: Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
Occurrence:
{
Description: Gets or sets the occurrence. Must be between -5 and 5. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
state:
{
Description: Gets or set the job state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Faulted: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Gets the job status. ,
Required: False ,
}
{
executionCount:
{
Description: Gets the number of times this job has executed. ,
Required: False ,
}
integer ,
failureCount:
{
Description: Gets the number of times this job has failed. ,
Required: False ,
}
integer ,
faultedCount:
{
Description: Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states). ,
Required: False ,
}
integer ,
lastExecutionTime:
{
Description: Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet. ,
Format: date-time ,
Required: False ,
}
string ,
nextExecutionTime:
{
Description: Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
Jobs_CreateOrUpdate (new)
Description :  Provisions a new job or updates an existing job.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
jobCollectionName:
{
Description: The job collection name. ,
Required: True ,
}
string ,
jobName:
{
Description: The job name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
job:
{
Description: The job definition. ,
Required: True ,
}
{
id:
{
Description: Gets the job resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets the job resource name. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the job properties. ,
Required: False ,
}
{
startTime:
{
Description: Gets or sets the job start time. ,
Format: date-time ,
Required: False ,
}
string ,
action:
{
Description: Gets or sets the job action. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the job action type. ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
StorageQueue: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
}
,
Required: False ,
}
enum ,
request:
{
Description: Gets or sets the http requests. ,
Required: False ,
}
{
authentication:
{
Description: Gets or sets the authentication method of the request. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the HTTP authentication type. ,
Enum:
{
NotSpecified: No description available. ,
ClientCertificate: No description available. ,
ActiveDirectoryOAuth: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
uri:
{
Description: Gets or sets the URI of the request. ,
Required: False ,
}
string ,
method:
{
Description: Gets or sets the method of the request. ,
Required: False ,
}
string ,
body:
{
Description: Gets or sets the request body. ,
Required: False ,
}
string ,
headers:
{
Description: Gets or sets the headers. ,
Required: False ,
}
object ,
}
,
queueMessage:
{
Description: Gets or sets the storage queue message. ,
Required: False ,
}
{
storageAccount:
{
Description: Gets or sets the storage account name. ,
Required: False ,
}
string ,
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
sasToken:
{
Description: Gets or sets the SAS key. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message. ,
Required: False ,
}
string ,
}
,
serviceBusQueueMessage:
{
Description: Gets or sets the service bus queue message. ,
Required: False ,
}
{
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
}
,
serviceBusTopicMessage:
{
Description: Gets or sets the service bus topic message. ,
Required: False ,
}
{
topicPath:
{
Description: Gets or sets the topic path. ,
Required: False ,
}
string ,
}
,
retryPolicy:
{
Description: Gets or sets the retry policy. ,
Required: False ,
}
{
retryType:
{
Description: Gets or sets the retry strategy to be used. ,
Enum:
{
None: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
retryInterval:
{
Description: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets or sets the number of times a retry should be attempted. ,
Required: False ,
}
integer ,
}
,
errorAction:
{
Description: Gets or sets the error action. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the job error action type. ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
StorageQueue: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
}
,
Required: False ,
}
enum ,
request:
{
Description: Gets or sets the http requests. ,
Required: False ,
}
{
authentication:
{
Description: Gets or sets the authentication method of the request. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the HTTP authentication type. ,
Enum:
{
NotSpecified: No description available. ,
ClientCertificate: No description available. ,
ActiveDirectoryOAuth: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
uri:
{
Description: Gets or sets the URI of the request. ,
Required: False ,
}
string ,
method:
{
Description: Gets or sets the method of the request. ,
Required: False ,
}
string ,
body:
{
Description: Gets or sets the request body. ,
Required: False ,
}
string ,
headers:
{
Description: Gets or sets the headers. ,
Required: False ,
}
object ,
}
,
queueMessage:
{
Description: Gets or sets the storage queue message. ,
Required: False ,
}
{
storageAccount:
{
Description: Gets or sets the storage account name. ,
Required: False ,
}
string ,
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
sasToken:
{
Description: Gets or sets the SAS key. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message. ,
Required: False ,
}
string ,
}
,
serviceBusQueueMessage:
{
Description: Gets or sets the service bus queue message. ,
Required: False ,
}
{
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
}
,
serviceBusTopicMessage:
{
Description: Gets or sets the service bus topic message. ,
Required: False ,
}
{
topicPath:
{
Description: Gets or sets the topic path. ,
Required: False ,
}
string ,
}
,
retryPolicy:
{
Description: Gets or sets the retry policy. ,
Required: False ,
}
{
retryType:
{
Description: Gets or sets the retry strategy to be used. ,
Enum:
{
None: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
retryInterval:
{
Description: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets or sets the number of times a retry should be attempted. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
recurrence:
{
Description: Gets or sets the job recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
count:
{
Description: Gets or sets the maximum number of times that the job should run. ,
Required: False ,
}
integer ,
endTime:
{
Description: Gets or sets the time at which the job will complete. ,
Format: date-time ,
Required: False ,
}
string ,
schedule:
{
Required: False ,
}
{
weekDays:
{
Description: Gets or sets the days of the week that the job should execute on. ,
Required: False ,
}
[
string ,
]
,
hours:
{
Description: Gets or sets the hours of the day that the job should execute at. ,
Required: False ,
}
[
integer ,
]
,
minutes:
{
Description: Gets or sets the minutes of the hour that the job should execute at. ,
Required: False ,
}
[
integer ,
]
,
monthDays:
{
Description: Gets or sets the days of the month that the job should execute on. Must be between 1 and 31. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: Gets or sets the occurrences of days within a month. ,
Required: False ,
}
[
{
day:
{
Description: Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
Occurrence:
{
Description: Gets or sets the occurrence. Must be between -5 and 5. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
state:
{
Description: Gets or set the job state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Faulted: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Gets the job status. ,
Required: False ,
}
{
executionCount:
{
Description: Gets the number of times this job has executed. ,
Required: False ,
}
integer ,
failureCount:
{
Description: Gets the number of times this job has failed. ,
Required: False ,
}
integer ,
faultedCount:
{
Description: Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states). ,
Required: False ,
}
integer ,
lastExecutionTime:
{
Description: Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet. ,
Format: date-time ,
Required: False ,
}
string ,
nextExecutionTime:
{
Description: Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Gets the job resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets the job resource name. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the job properties. ,
Required: False ,
}
{
startTime:
{
Description: Gets or sets the job start time. ,
Format: date-time ,
Required: False ,
}
string ,
action:
{
Description: Gets or sets the job action. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the job action type. ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
StorageQueue: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
}
,
Required: False ,
}
enum ,
request:
{
Description: Gets or sets the http requests. ,
Required: False ,
}
{
authentication:
{
Description: Gets or sets the authentication method of the request. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the HTTP authentication type. ,
Enum:
{
NotSpecified: No description available. ,
ClientCertificate: No description available. ,
ActiveDirectoryOAuth: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
uri:
{
Description: Gets or sets the URI of the request. ,
Required: False ,
}
string ,
method:
{
Description: Gets or sets the method of the request. ,
Required: False ,
}
string ,
body:
{
Description: Gets or sets the request body. ,
Required: False ,
}
string ,
headers:
{
Description: Gets or sets the headers. ,
Required: False ,
}
object ,
}
,
queueMessage:
{
Description: Gets or sets the storage queue message. ,
Required: False ,
}
{
storageAccount:
{
Description: Gets or sets the storage account name. ,
Required: False ,
}
string ,
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
sasToken:
{
Description: Gets or sets the SAS key. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message. ,
Required: False ,
}
string ,
}
,
serviceBusQueueMessage:
{
Description: Gets or sets the service bus queue message. ,
Required: False ,
}
{
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
}
,
serviceBusTopicMessage:
{
Description: Gets or sets the service bus topic message. ,
Required: False ,
}
{
topicPath:
{
Description: Gets or sets the topic path. ,
Required: False ,
}
string ,
}
,
retryPolicy:
{
Description: Gets or sets the retry policy. ,
Required: False ,
}
{
retryType:
{
Description: Gets or sets the retry strategy to be used. ,
Enum:
{
None: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
retryInterval:
{
Description: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets or sets the number of times a retry should be attempted. ,
Required: False ,
}
integer ,
}
,
errorAction:
{
Description: Gets or sets the error action. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the job error action type. ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
StorageQueue: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
}
,
Required: False ,
}
enum ,
request:
{
Description: Gets or sets the http requests. ,
Required: False ,
}
{
authentication:
{
Description: Gets or sets the authentication method of the request. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the HTTP authentication type. ,
Enum:
{
NotSpecified: No description available. ,
ClientCertificate: No description available. ,
ActiveDirectoryOAuth: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
uri:
{
Description: Gets or sets the URI of the request. ,
Required: False ,
}
string ,
method:
{
Description: Gets or sets the method of the request. ,
Required: False ,
}
string ,
body:
{
Description: Gets or sets the request body. ,
Required: False ,
}
string ,
headers:
{
Description: Gets or sets the headers. ,
Required: False ,
}
object ,
}
,
queueMessage:
{
Description: Gets or sets the storage queue message. ,
Required: False ,
}
{
storageAccount:
{
Description: Gets or sets the storage account name. ,
Required: False ,
}
string ,
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
sasToken:
{
Description: Gets or sets the SAS key. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message. ,
Required: False ,
}
string ,
}
,
serviceBusQueueMessage:
{
Description: Gets or sets the service bus queue message. ,
Required: False ,
}
{
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
}
,
serviceBusTopicMessage:
{
Description: Gets or sets the service bus topic message. ,
Required: False ,
}
{
topicPath:
{
Description: Gets or sets the topic path. ,
Required: False ,
}
string ,
}
,
retryPolicy:
{
Description: Gets or sets the retry policy. ,
Required: False ,
}
{
retryType:
{
Description: Gets or sets the retry strategy to be used. ,
Enum:
{
None: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
retryInterval:
{
Description: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets or sets the number of times a retry should be attempted. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
recurrence:
{
Description: Gets or sets the job recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
count:
{
Description: Gets or sets the maximum number of times that the job should run. ,
Required: False ,
}
integer ,
endTime:
{
Description: Gets or sets the time at which the job will complete. ,
Format: date-time ,
Required: False ,
}
string ,
schedule:
{
Required: False ,
}
{
weekDays:
{
Description: Gets or sets the days of the week that the job should execute on. ,
Required: False ,
}
[
string ,
]
,
hours:
{
Description: Gets or sets the hours of the day that the job should execute at. ,
Required: False ,
}
[
integer ,
]
,
minutes:
{
Description: Gets or sets the minutes of the hour that the job should execute at. ,
Required: False ,
}
[
integer ,
]
,
monthDays:
{
Description: Gets or sets the days of the month that the job should execute on. Must be between 1 and 31. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: Gets or sets the occurrences of days within a month. ,
Required: False ,
}
[
{
day:
{
Description: Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
Occurrence:
{
Description: Gets or sets the occurrence. Must be between -5 and 5. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
state:
{
Description: Gets or set the job state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Faulted: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Gets the job status. ,
Required: False ,
}
{
executionCount:
{
Description: Gets the number of times this job has executed. ,
Required: False ,
}
integer ,
failureCount:
{
Description: Gets the number of times this job has failed. ,
Required: False ,
}
integer ,
faultedCount:
{
Description: Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states). ,
Required: False ,
}
integer ,
lastExecutionTime:
{
Description: Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet. ,
Format: date-time ,
Required: False ,
}
string ,
nextExecutionTime:
{
Description: Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
id:
{
Description: Gets the job resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets the job resource name. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the job properties. ,
Required: False ,
}
{
startTime:
{
Description: Gets or sets the job start time. ,
Format: date-time ,
Required: False ,
}
string ,
action:
{
Description: Gets or sets the job action. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the job action type. ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
StorageQueue: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
}
,
Required: False ,
}
enum ,
request:
{
Description: Gets or sets the http requests. ,
Required: False ,
}
{
authentication:
{
Description: Gets or sets the authentication method of the request. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the HTTP authentication type. ,
Enum:
{
NotSpecified: No description available. ,
ClientCertificate: No description available. ,
ActiveDirectoryOAuth: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
uri:
{
Description: Gets or sets the URI of the request. ,
Required: False ,
}
string ,
method:
{
Description: Gets or sets the method of the request. ,
Required: False ,
}
string ,
body:
{
Description: Gets or sets the request body. ,
Required: False ,
}
string ,
headers:
{
Description: Gets or sets the headers. ,
Required: False ,
}
object ,
}
,
queueMessage:
{
Description: Gets or sets the storage queue message. ,
Required: False ,
}
{
storageAccount:
{
Description: Gets or sets the storage account name. ,
Required: False ,
}
string ,
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
sasToken:
{
Description: Gets or sets the SAS key. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message. ,
Required: False ,
}
string ,
}
,
serviceBusQueueMessage:
{
Description: Gets or sets the service bus queue message. ,
Required: False ,
}
{
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
}
,
serviceBusTopicMessage:
{
Description: Gets or sets the service bus topic message. ,
Required: False ,
}
{
topicPath:
{
Description: Gets or sets the topic path. ,
Required: False ,
}
string ,
}
,
retryPolicy:
{
Description: Gets or sets the retry policy. ,
Required: False ,
}
{
retryType:
{
Description: Gets or sets the retry strategy to be used. ,
Enum:
{
None: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
retryInterval:
{
Description: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets or sets the number of times a retry should be attempted. ,
Required: False ,
}
integer ,
}
,
errorAction:
{
Description: Gets or sets the error action. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the job error action type. ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
StorageQueue: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
}
,
Required: False ,
}
enum ,
request:
{
Description: Gets or sets the http requests. ,
Required: False ,
}
{
authentication:
{
Description: Gets or sets the authentication method of the request. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the HTTP authentication type. ,
Enum:
{
NotSpecified: No description available. ,
ClientCertificate: No description available. ,
ActiveDirectoryOAuth: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
uri:
{
Description: Gets or sets the URI of the request. ,
Required: False ,
}
string ,
method:
{
Description: Gets or sets the method of the request. ,
Required: False ,
}
string ,
body:
{
Description: Gets or sets the request body. ,
Required: False ,
}
string ,
headers:
{
Description: Gets or sets the headers. ,
Required: False ,
}
object ,
}
,
queueMessage:
{
Description: Gets or sets the storage queue message. ,
Required: False ,
}
{
storageAccount:
{
Description: Gets or sets the storage account name. ,
Required: False ,
}
string ,
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
sasToken:
{
Description: Gets or sets the SAS key. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message. ,
Required: False ,
}
string ,
}
,
serviceBusQueueMessage:
{
Description: Gets or sets the service bus queue message. ,
Required: False ,
}
{
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
}
,
serviceBusTopicMessage:
{
Description: Gets or sets the service bus topic message. ,
Required: False ,
}
{
topicPath:
{
Description: Gets or sets the topic path. ,
Required: False ,
}
string ,
}
,
retryPolicy:
{
Description: Gets or sets the retry policy. ,
Required: False ,
}
{
retryType:
{
Description: Gets or sets the retry strategy to be used. ,
Enum:
{
None: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
retryInterval:
{
Description: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets or sets the number of times a retry should be attempted. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
recurrence:
{
Description: Gets or sets the job recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
count:
{
Description: Gets or sets the maximum number of times that the job should run. ,
Required: False ,
}
integer ,
endTime:
{
Description: Gets or sets the time at which the job will complete. ,
Format: date-time ,
Required: False ,
}
string ,
schedule:
{
Required: False ,
}
{
weekDays:
{
Description: Gets or sets the days of the week that the job should execute on. ,
Required: False ,
}
[
string ,
]
,
hours:
{
Description: Gets or sets the hours of the day that the job should execute at. ,
Required: False ,
}
[
integer ,
]
,
minutes:
{
Description: Gets or sets the minutes of the hour that the job should execute at. ,
Required: False ,
}
[
integer ,
]
,
monthDays:
{
Description: Gets or sets the days of the month that the job should execute on. Must be between 1 and 31. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: Gets or sets the occurrences of days within a month. ,
Required: False ,
}
[
{
day:
{
Description: Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
Occurrence:
{
Description: Gets or sets the occurrence. Must be between -5 and 5. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
state:
{
Description: Gets or set the job state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Faulted: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Gets the job status. ,
Required: False ,
}
{
executionCount:
{
Description: Gets the number of times this job has executed. ,
Required: False ,
}
integer ,
failureCount:
{
Description: Gets the number of times this job has failed. ,
Required: False ,
}
integer ,
faultedCount:
{
Description: Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states). ,
Required: False ,
}
integer ,
lastExecutionTime:
{
Description: Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet. ,
Format: date-time ,
Required: False ,
}
string ,
nextExecutionTime:
{
Description: Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
Jobs_Patch (new)
Description :  Patches an existing job.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
jobCollectionName:
{
Description: The job collection name. ,
Required: True ,
}
string ,
jobName:
{
Description: The job name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
job:
{
Description: The job definition. ,
Required: True ,
}
{
id:
{
Description: Gets the job resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets the job resource name. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the job properties. ,
Required: False ,
}
{
startTime:
{
Description: Gets or sets the job start time. ,
Format: date-time ,
Required: False ,
}
string ,
action:
{
Description: Gets or sets the job action. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the job action type. ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
StorageQueue: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
}
,
Required: False ,
}
enum ,
request:
{
Description: Gets or sets the http requests. ,
Required: False ,
}
{
authentication:
{
Description: Gets or sets the authentication method of the request. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the HTTP authentication type. ,
Enum:
{
NotSpecified: No description available. ,
ClientCertificate: No description available. ,
ActiveDirectoryOAuth: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
uri:
{
Description: Gets or sets the URI of the request. ,
Required: False ,
}
string ,
method:
{
Description: Gets or sets the method of the request. ,
Required: False ,
}
string ,
body:
{
Description: Gets or sets the request body. ,
Required: False ,
}
string ,
headers:
{
Description: Gets or sets the headers. ,
Required: False ,
}
object ,
}
,
queueMessage:
{
Description: Gets or sets the storage queue message. ,
Required: False ,
}
{
storageAccount:
{
Description: Gets or sets the storage account name. ,
Required: False ,
}
string ,
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
sasToken:
{
Description: Gets or sets the SAS key. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message. ,
Required: False ,
}
string ,
}
,
serviceBusQueueMessage:
{
Description: Gets or sets the service bus queue message. ,
Required: False ,
}
{
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
}
,
serviceBusTopicMessage:
{
Description: Gets or sets the service bus topic message. ,
Required: False ,
}
{
topicPath:
{
Description: Gets or sets the topic path. ,
Required: False ,
}
string ,
}
,
retryPolicy:
{
Description: Gets or sets the retry policy. ,
Required: False ,
}
{
retryType:
{
Description: Gets or sets the retry strategy to be used. ,
Enum:
{
None: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
retryInterval:
{
Description: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets or sets the number of times a retry should be attempted. ,
Required: False ,
}
integer ,
}
,
errorAction:
{
Description: Gets or sets the error action. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the job error action type. ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
StorageQueue: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
}
,
Required: False ,
}
enum ,
request:
{
Description: Gets or sets the http requests. ,
Required: False ,
}
{
authentication:
{
Description: Gets or sets the authentication method of the request. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the HTTP authentication type. ,
Enum:
{
NotSpecified: No description available. ,
ClientCertificate: No description available. ,
ActiveDirectoryOAuth: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
uri:
{
Description: Gets or sets the URI of the request. ,
Required: False ,
}
string ,
method:
{
Description: Gets or sets the method of the request. ,
Required: False ,
}
string ,
body:
{
Description: Gets or sets the request body. ,
Required: False ,
}
string ,
headers:
{
Description: Gets or sets the headers. ,
Required: False ,
}
object ,
}
,
queueMessage:
{
Description: Gets or sets the storage queue message. ,
Required: False ,
}
{
storageAccount:
{
Description: Gets or sets the storage account name. ,
Required: False ,
}
string ,
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
sasToken:
{
Description: Gets or sets the SAS key. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message. ,
Required: False ,
}
string ,
}
,
serviceBusQueueMessage:
{
Description: Gets or sets the service bus queue message. ,
Required: False ,
}
{
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
}
,
serviceBusTopicMessage:
{
Description: Gets or sets the service bus topic message. ,
Required: False ,
}
{
topicPath:
{
Description: Gets or sets the topic path. ,
Required: False ,
}
string ,
}
,
retryPolicy:
{
Description: Gets or sets the retry policy. ,
Required: False ,
}
{
retryType:
{
Description: Gets or sets the retry strategy to be used. ,
Enum:
{
None: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
retryInterval:
{
Description: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets or sets the number of times a retry should be attempted. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
recurrence:
{
Description: Gets or sets the job recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
count:
{
Description: Gets or sets the maximum number of times that the job should run. ,
Required: False ,
}
integer ,
endTime:
{
Description: Gets or sets the time at which the job will complete. ,
Format: date-time ,
Required: False ,
}
string ,
schedule:
{
Required: False ,
}
{
weekDays:
{
Description: Gets or sets the days of the week that the job should execute on. ,
Required: False ,
}
[
string ,
]
,
hours:
{
Description: Gets or sets the hours of the day that the job should execute at. ,
Required: False ,
}
[
integer ,
]
,
minutes:
{
Description: Gets or sets the minutes of the hour that the job should execute at. ,
Required: False ,
}
[
integer ,
]
,
monthDays:
{
Description: Gets or sets the days of the month that the job should execute on. Must be between 1 and 31. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: Gets or sets the occurrences of days within a month. ,
Required: False ,
}
[
{
day:
{
Description: Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
Occurrence:
{
Description: Gets or sets the occurrence. Must be between -5 and 5. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
state:
{
Description: Gets or set the job state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Faulted: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Gets the job status. ,
Required: False ,
}
{
executionCount:
{
Description: Gets the number of times this job has executed. ,
Required: False ,
}
integer ,
failureCount:
{
Description: Gets the number of times this job has failed. ,
Required: False ,
}
integer ,
faultedCount:
{
Description: Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states). ,
Required: False ,
}
integer ,
lastExecutionTime:
{
Description: Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet. ,
Format: date-time ,
Required: False ,
}
string ,
nextExecutionTime:
{
Description: Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Gets the job resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets the job resource name. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the job properties. ,
Required: False ,
}
{
startTime:
{
Description: Gets or sets the job start time. ,
Format: date-time ,
Required: False ,
}
string ,
action:
{
Description: Gets or sets the job action. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the job action type. ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
StorageQueue: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
}
,
Required: False ,
}
enum ,
request:
{
Description: Gets or sets the http requests. ,
Required: False ,
}
{
authentication:
{
Description: Gets or sets the authentication method of the request. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the HTTP authentication type. ,
Enum:
{
NotSpecified: No description available. ,
ClientCertificate: No description available. ,
ActiveDirectoryOAuth: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
uri:
{
Description: Gets or sets the URI of the request. ,
Required: False ,
}
string ,
method:
{
Description: Gets or sets the method of the request. ,
Required: False ,
}
string ,
body:
{
Description: Gets or sets the request body. ,
Required: False ,
}
string ,
headers:
{
Description: Gets or sets the headers. ,
Required: False ,
}
object ,
}
,
queueMessage:
{
Description: Gets or sets the storage queue message. ,
Required: False ,
}
{
storageAccount:
{
Description: Gets or sets the storage account name. ,
Required: False ,
}
string ,
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
sasToken:
{
Description: Gets or sets the SAS key. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message. ,
Required: False ,
}
string ,
}
,
serviceBusQueueMessage:
{
Description: Gets or sets the service bus queue message. ,
Required: False ,
}
{
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
}
,
serviceBusTopicMessage:
{
Description: Gets or sets the service bus topic message. ,
Required: False ,
}
{
topicPath:
{
Description: Gets or sets the topic path. ,
Required: False ,
}
string ,
}
,
retryPolicy:
{
Description: Gets or sets the retry policy. ,
Required: False ,
}
{
retryType:
{
Description: Gets or sets the retry strategy to be used. ,
Enum:
{
None: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
retryInterval:
{
Description: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets or sets the number of times a retry should be attempted. ,
Required: False ,
}
integer ,
}
,
errorAction:
{
Description: Gets or sets the error action. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the job error action type. ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
StorageQueue: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
}
,
Required: False ,
}
enum ,
request:
{
Description: Gets or sets the http requests. ,
Required: False ,
}
{
authentication:
{
Description: Gets or sets the authentication method of the request. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the HTTP authentication type. ,
Enum:
{
NotSpecified: No description available. ,
ClientCertificate: No description available. ,
ActiveDirectoryOAuth: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
uri:
{
Description: Gets or sets the URI of the request. ,
Required: False ,
}
string ,
method:
{
Description: Gets or sets the method of the request. ,
Required: False ,
}
string ,
body:
{
Description: Gets or sets the request body. ,
Required: False ,
}
string ,
headers:
{
Description: Gets or sets the headers. ,
Required: False ,
}
object ,
}
,
queueMessage:
{
Description: Gets or sets the storage queue message. ,
Required: False ,
}
{
storageAccount:
{
Description: Gets or sets the storage account name. ,
Required: False ,
}
string ,
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
sasToken:
{
Description: Gets or sets the SAS key. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message. ,
Required: False ,
}
string ,
}
,
serviceBusQueueMessage:
{
Description: Gets or sets the service bus queue message. ,
Required: False ,
}
{
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
}
,
serviceBusTopicMessage:
{
Description: Gets or sets the service bus topic message. ,
Required: False ,
}
{
topicPath:
{
Description: Gets or sets the topic path. ,
Required: False ,
}
string ,
}
,
retryPolicy:
{
Description: Gets or sets the retry policy. ,
Required: False ,
}
{
retryType:
{
Description: Gets or sets the retry strategy to be used. ,
Enum:
{
None: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
retryInterval:
{
Description: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets or sets the number of times a retry should be attempted. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
recurrence:
{
Description: Gets or sets the job recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
count:
{
Description: Gets or sets the maximum number of times that the job should run. ,
Required: False ,
}
integer ,
endTime:
{
Description: Gets or sets the time at which the job will complete. ,
Format: date-time ,
Required: False ,
}
string ,
schedule:
{
Required: False ,
}
{
weekDays:
{
Description: Gets or sets the days of the week that the job should execute on. ,
Required: False ,
}
[
string ,
]
,
hours:
{
Description: Gets or sets the hours of the day that the job should execute at. ,
Required: False ,
}
[
integer ,
]
,
minutes:
{
Description: Gets or sets the minutes of the hour that the job should execute at. ,
Required: False ,
}
[
integer ,
]
,
monthDays:
{
Description: Gets or sets the days of the month that the job should execute on. Must be between 1 and 31. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: Gets or sets the occurrences of days within a month. ,
Required: False ,
}
[
{
day:
{
Description: Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
Occurrence:
{
Description: Gets or sets the occurrence. Must be between -5 and 5. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
state:
{
Description: Gets or set the job state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Faulted: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Gets the job status. ,
Required: False ,
}
{
executionCount:
{
Description: Gets the number of times this job has executed. ,
Required: False ,
}
integer ,
failureCount:
{
Description: Gets the number of times this job has failed. ,
Required: False ,
}
integer ,
faultedCount:
{
Description: Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states). ,
Required: False ,
}
integer ,
lastExecutionTime:
{
Description: Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet. ,
Format: date-time ,
Required: False ,
}
string ,
nextExecutionTime:
{
Description: Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
Jobs_Delete (new)
Description :  Deletes a job.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
jobCollectionName:
{
Description: The job collection name. ,
Required: True ,
}
string ,
jobName:
{
Description: The job name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
Jobs_Run (new)
Description :  Runs a job.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}/run
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
jobCollectionName:
{
Description: The job collection name. ,
Required: True ,
}
string ,
jobName:
{
Description: The job name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
Jobs_List (new)
Description :  Lists all jobs under the specified job collection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
jobCollectionName:
{
Description: The job collection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
$top:
{
Description: The number of jobs to request, in the of range of [1..100]. ,
Required: False ,
}
integer ,
$skip:
{
Description: The (0-based) index of the job history list from which to begin requesting entries. ,
Required: False ,
}
integer ,
$filter:
{
Description: The filter to apply on the job state. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets all jobs under job collection. ,
Required: False ,
}
[
{
id:
{
Description: Gets the job resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets the job resource name. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the job properties. ,
Required: False ,
}
{
startTime:
{
Description: Gets or sets the job start time. ,
Format: date-time ,
Required: False ,
}
string ,
action:
{
Description: Gets or sets the job action. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the job action type. ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
StorageQueue: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
}
,
Required: False ,
}
enum ,
request:
{
Description: Gets or sets the http requests. ,
Required: False ,
}
{
authentication:
{
Description: Gets or sets the authentication method of the request. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the HTTP authentication type. ,
Enum:
{
NotSpecified: No description available. ,
ClientCertificate: No description available. ,
ActiveDirectoryOAuth: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
uri:
{
Description: Gets or sets the URI of the request. ,
Required: False ,
}
string ,
method:
{
Description: Gets or sets the method of the request. ,
Required: False ,
}
string ,
body:
{
Description: Gets or sets the request body. ,
Required: False ,
}
string ,
headers:
{
Description: Gets or sets the headers. ,
Required: False ,
}
object ,
}
,
queueMessage:
{
Description: Gets or sets the storage queue message. ,
Required: False ,
}
{
storageAccount:
{
Description: Gets or sets the storage account name. ,
Required: False ,
}
string ,
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
sasToken:
{
Description: Gets or sets the SAS key. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message. ,
Required: False ,
}
string ,
}
,
serviceBusQueueMessage:
{
Description: Gets or sets the service bus queue message. ,
Required: False ,
}
{
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
}
,
serviceBusTopicMessage:
{
Description: Gets or sets the service bus topic message. ,
Required: False ,
}
{
topicPath:
{
Description: Gets or sets the topic path. ,
Required: False ,
}
string ,
}
,
retryPolicy:
{
Description: Gets or sets the retry policy. ,
Required: False ,
}
{
retryType:
{
Description: Gets or sets the retry strategy to be used. ,
Enum:
{
None: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
retryInterval:
{
Description: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets or sets the number of times a retry should be attempted. ,
Required: False ,
}
integer ,
}
,
errorAction:
{
Description: Gets or sets the error action. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the job error action type. ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
StorageQueue: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
}
,
Required: False ,
}
enum ,
request:
{
Description: Gets or sets the http requests. ,
Required: False ,
}
{
authentication:
{
Description: Gets or sets the authentication method of the request. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the HTTP authentication type. ,
Enum:
{
NotSpecified: No description available. ,
ClientCertificate: No description available. ,
ActiveDirectoryOAuth: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
uri:
{
Description: Gets or sets the URI of the request. ,
Required: False ,
}
string ,
method:
{
Description: Gets or sets the method of the request. ,
Required: False ,
}
string ,
body:
{
Description: Gets or sets the request body. ,
Required: False ,
}
string ,
headers:
{
Description: Gets or sets the headers. ,
Required: False ,
}
object ,
}
,
queueMessage:
{
Description: Gets or sets the storage queue message. ,
Required: False ,
}
{
storageAccount:
{
Description: Gets or sets the storage account name. ,
Required: False ,
}
string ,
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
sasToken:
{
Description: Gets or sets the SAS key. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message. ,
Required: False ,
}
string ,
}
,
serviceBusQueueMessage:
{
Description: Gets or sets the service bus queue message. ,
Required: False ,
}
{
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
}
,
serviceBusTopicMessage:
{
Description: Gets or sets the service bus topic message. ,
Required: False ,
}
{
topicPath:
{
Description: Gets or sets the topic path. ,
Required: False ,
}
string ,
}
,
retryPolicy:
{
Description: Gets or sets the retry policy. ,
Required: False ,
}
{
retryType:
{
Description: Gets or sets the retry strategy to be used. ,
Enum:
{
None: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
retryInterval:
{
Description: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets or sets the number of times a retry should be attempted. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
recurrence:
{
Description: Gets or sets the job recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
count:
{
Description: Gets or sets the maximum number of times that the job should run. ,
Required: False ,
}
integer ,
endTime:
{
Description: Gets or sets the time at which the job will complete. ,
Format: date-time ,
Required: False ,
}
string ,
schedule:
{
Required: False ,
}
{
weekDays:
{
Description: Gets or sets the days of the week that the job should execute on. ,
Required: False ,
}
[
string ,
]
,
hours:
{
Description: Gets or sets the hours of the day that the job should execute at. ,
Required: False ,
}
[
integer ,
]
,
minutes:
{
Description: Gets or sets the minutes of the hour that the job should execute at. ,
Required: False ,
}
[
integer ,
]
,
monthDays:
{
Description: Gets or sets the days of the month that the job should execute on. Must be between 1 and 31. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: Gets or sets the occurrences of days within a month. ,
Required: False ,
}
[
{
day:
{
Description: Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
Occurrence:
{
Description: Gets or sets the occurrence. Must be between -5 and 5. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
state:
{
Description: Gets or set the job state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Faulted: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Gets the job status. ,
Required: False ,
}
{
executionCount:
{
Description: Gets the number of times this job has executed. ,
Required: False ,
}
integer ,
failureCount:
{
Description: Gets the number of times this job has failed. ,
Required: False ,
}
integer ,
faultedCount:
{
Description: Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states). ,
Required: False ,
}
integer ,
lastExecutionTime:
{
Description: Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet. ,
Format: date-time ,
Required: False ,
}
string ,
nextExecutionTime:
{
Description: Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets the URL to get the next set of jobs. ,
Required: False ,
}
string ,
}
Jobs_ListJobHistory (new)
Description :  Lists job history.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}/history
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
jobCollectionName:
{
Description: The job collection name. ,
Required: True ,
}
string ,
jobName:
{
Description: The job name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
$top:
{
Description: the number of job history to request, in the of range of [1..100]. ,
Required: False ,
}
integer ,
$skip:
{
Description: The (0-based) index of the job history list from which to begin requesting entries. ,
Required: False ,
}
integer ,
$filter:
{
Description: The filter to apply on the job state. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the job histories under job. ,
Required: False ,
}
[
{
id:
{
Description: Gets the job history identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job history resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets the job history name. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the job history properties. ,
Required: False ,
}
{
startTime:
{
Description: Gets the start time for this job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time for this job. ,
Format: date-time ,
Required: False ,
}
string ,
expectedExecutionTime:
{
Description: Gets the expected execution time for this job. ,
Format: date-time ,
Required: False ,
}
string ,
actionName:
{
Description: Gets the job history action name. ,
Enum:
{
MainAction: No description available. ,
ErrorAction: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Gets the job history status. ,
Enum:
{
Completed: No description available. ,
Failed: No description available. ,
Postponed: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Gets the message for the job history. ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets the retry count for job. ,
Required: False ,
}
integer ,
repeatCount:
{
Description: Gets the repeat count for the job. ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets the URL to get the next set of job histories. ,
Required: False ,
}
string ,
}
JobCollections_ListBySubscription (removed)
Description :  Gets all job collections under specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Scheduler/jobCollections
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the job collections. ,
Required: False ,
}
[
{
id:
{
Description: Gets the job collection resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job collection resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the job collection resource name. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the storage account location. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets the tags. ,
Required: False ,
}
object ,
properties:
{
Description: Gets or sets the job collection properties. ,
Required: False ,
}
{
sku:
{
Description: Gets or sets the SKU. ,
Required: False ,
}
{
name:
{
Description: Gets or set the SKU. ,
Enum:
{
Standard: No description available. ,
Free: No description available. ,
P10Premium: No description available. ,
P20Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
state:
{
Description: Gets or sets the state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
quota:
{
Description: Gets or sets the job collection quota. ,
Required: False ,
}
{
maxJobCount:
{
Description: Gets or set the maximum job count. ,
Required: False ,
}
integer ,
maxJobOccurrence:
{
Description: Gets or sets the maximum job occurrence. ,
Required: False ,
}
integer ,
maxRecurrence:
{
Description: Gets or set the maximum recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets the URL to get the next set of job collections. ,
Required: False ,
}
string ,
}
JobCollections_ListByResourceGroup (removed)
Description :  Gets all job collections under specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the job collections. ,
Required: False ,
}
[
{
id:
{
Description: Gets the job collection resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job collection resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the job collection resource name. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the storage account location. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets the tags. ,
Required: False ,
}
object ,
properties:
{
Description: Gets or sets the job collection properties. ,
Required: False ,
}
{
sku:
{
Description: Gets or sets the SKU. ,
Required: False ,
}
{
name:
{
Description: Gets or set the SKU. ,
Enum:
{
Standard: No description available. ,
Free: No description available. ,
P10Premium: No description available. ,
P20Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
state:
{
Description: Gets or sets the state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
quota:
{
Description: Gets or sets the job collection quota. ,
Required: False ,
}
{
maxJobCount:
{
Description: Gets or set the maximum job count. ,
Required: False ,
}
integer ,
maxJobOccurrence:
{
Description: Gets or sets the maximum job occurrence. ,
Required: False ,
}
integer ,
maxRecurrence:
{
Description: Gets or set the maximum recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets the URL to get the next set of job collections. ,
Required: False ,
}
string ,
}
JobCollections_Get (removed)
Description :  Gets a job collection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
jobCollectionName:
{
Description: The job collection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets the job collection resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job collection resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the job collection resource name. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the storage account location. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets the tags. ,
Required: False ,
}
object ,
properties:
{
Description: Gets or sets the job collection properties. ,
Required: False ,
}
{
sku:
{
Description: Gets or sets the SKU. ,
Required: False ,
}
{
name:
{
Description: Gets or set the SKU. ,
Enum:
{
Standard: No description available. ,
Free: No description available. ,
P10Premium: No description available. ,
P20Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
state:
{
Description: Gets or sets the state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
quota:
{
Description: Gets or sets the job collection quota. ,
Required: False ,
}
{
maxJobCount:
{
Description: Gets or set the maximum job count. ,
Required: False ,
}
integer ,
maxJobOccurrence:
{
Description: Gets or sets the maximum job occurrence. ,
Required: False ,
}
integer ,
maxRecurrence:
{
Description: Gets or set the maximum recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
JobCollections_CreateOrUpdate (removed)
Description :  Provisions a new job collection or updates an existing job collection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
jobCollectionName:
{
Description: The job collection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
jobCollection:
{
Description: The job collection definition. ,
Required: True ,
}
{
id:
{
Description: Gets the job collection resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job collection resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the job collection resource name. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the storage account location. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets the tags. ,
Required: False ,
}
object ,
properties:
{
Description: Gets or sets the job collection properties. ,
Required: False ,
}
{
sku:
{
Description: Gets or sets the SKU. ,
Required: False ,
}
{
name:
{
Description: Gets or set the SKU. ,
Enum:
{
Standard: No description available. ,
Free: No description available. ,
P10Premium: No description available. ,
P20Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
state:
{
Description: Gets or sets the state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
quota:
{
Description: Gets or sets the job collection quota. ,
Required: False ,
}
{
maxJobCount:
{
Description: Gets or set the maximum job count. ,
Required: False ,
}
integer ,
maxJobOccurrence:
{
Description: Gets or sets the maximum job occurrence. ,
Required: False ,
}
integer ,
maxRecurrence:
{
Description: Gets or set the maximum recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Gets the job collection resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job collection resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the job collection resource name. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the storage account location. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets the tags. ,
Required: False ,
}
object ,
properties:
{
Description: Gets or sets the job collection properties. ,
Required: False ,
}
{
sku:
{
Description: Gets or sets the SKU. ,
Required: False ,
}
{
name:
{
Description: Gets or set the SKU. ,
Enum:
{
Standard: No description available. ,
Free: No description available. ,
P10Premium: No description available. ,
P20Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
state:
{
Description: Gets or sets the state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
quota:
{
Description: Gets or sets the job collection quota. ,
Required: False ,
}
{
maxJobCount:
{
Description: Gets or set the maximum job count. ,
Required: False ,
}
integer ,
maxJobOccurrence:
{
Description: Gets or sets the maximum job occurrence. ,
Required: False ,
}
integer ,
maxRecurrence:
{
Description: Gets or set the maximum recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}

⚐ Response (201)

{
id:
{
Description: Gets the job collection resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job collection resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the job collection resource name. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the storage account location. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets the tags. ,
Required: False ,
}
object ,
properties:
{
Description: Gets or sets the job collection properties. ,
Required: False ,
}
{
sku:
{
Description: Gets or sets the SKU. ,
Required: False ,
}
{
name:
{
Description: Gets or set the SKU. ,
Enum:
{
Standard: No description available. ,
Free: No description available. ,
P10Premium: No description available. ,
P20Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
state:
{
Description: Gets or sets the state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
quota:
{
Description: Gets or sets the job collection quota. ,
Required: False ,
}
{
maxJobCount:
{
Description: Gets or set the maximum job count. ,
Required: False ,
}
integer ,
maxJobOccurrence:
{
Description: Gets or sets the maximum job occurrence. ,
Required: False ,
}
integer ,
maxRecurrence:
{
Description: Gets or set the maximum recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
JobCollections_Patch (removed)
Description :  Patches an existing job collection.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
jobCollectionName:
{
Description: The job collection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
jobCollection:
{
Description: The job collection definition. ,
Required: True ,
}
{
id:
{
Description: Gets the job collection resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job collection resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the job collection resource name. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the storage account location. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets the tags. ,
Required: False ,
}
object ,
properties:
{
Description: Gets or sets the job collection properties. ,
Required: False ,
}
{
sku:
{
Description: Gets or sets the SKU. ,
Required: False ,
}
{
name:
{
Description: Gets or set the SKU. ,
Enum:
{
Standard: No description available. ,
Free: No description available. ,
P10Premium: No description available. ,
P20Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
state:
{
Description: Gets or sets the state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
quota:
{
Description: Gets or sets the job collection quota. ,
Required: False ,
}
{
maxJobCount:
{
Description: Gets or set the maximum job count. ,
Required: False ,
}
integer ,
maxJobOccurrence:
{
Description: Gets or sets the maximum job occurrence. ,
Required: False ,
}
integer ,
maxRecurrence:
{
Description: Gets or set the maximum recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Gets the job collection resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job collection resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the job collection resource name. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the storage account location. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets the tags. ,
Required: False ,
}
object ,
properties:
{
Description: Gets or sets the job collection properties. ,
Required: False ,
}
{
sku:
{
Description: Gets or sets the SKU. ,
Required: False ,
}
{
name:
{
Description: Gets or set the SKU. ,
Enum:
{
Standard: No description available. ,
Free: No description available. ,
P10Premium: No description available. ,
P20Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
state:
{
Description: Gets or sets the state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Suspended: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
quota:
{
Description: Gets or sets the job collection quota. ,
Required: False ,
}
{
maxJobCount:
{
Description: Gets or set the maximum job count. ,
Required: False ,
}
integer ,
maxJobOccurrence:
{
Description: Gets or sets the maximum job occurrence. ,
Required: False ,
}
integer ,
maxRecurrence:
{
Description: Gets or set the maximum recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
JobCollections_Delete (removed)
Description :  Deletes a job collection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
jobCollectionName:
{
Description: The job collection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
JobCollections_Enable (removed)
Description :  Enables all of the jobs in the job collection.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/enable
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
jobCollectionName:
{
Description: The job collection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
JobCollections_Disable (removed)
Description :  Disables all of the jobs in the job collection.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/disable
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
jobCollectionName:
{
Description: The job collection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
Jobs_Get (removed)
Description :  Gets a job.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
jobCollectionName:
{
Description: The job collection name. ,
Required: True ,
}
string ,
jobName:
{
Description: The job name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets the job resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets the job resource name. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the job properties. ,
Required: False ,
}
{
startTime:
{
Description: Gets or sets the job start time. ,
Format: date-time ,
Required: False ,
}
string ,
action:
{
Description: Gets or sets the job action. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the job action type. ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
StorageQueue: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
}
,
Required: False ,
}
enum ,
request:
{
Description: Gets or sets the http requests. ,
Required: False ,
}
{
authentication:
{
Description: Gets or sets the authentication method of the request. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the HTTP authentication type. ,
Enum:
{
NotSpecified: No description available. ,
ClientCertificate: No description available. ,
ActiveDirectoryOAuth: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
uri:
{
Description: Gets or sets the URI of the request. ,
Required: False ,
}
string ,
method:
{
Description: Gets or sets the method of the request. ,
Required: False ,
}
string ,
body:
{
Description: Gets or sets the request body. ,
Required: False ,
}
string ,
headers:
{
Description: Gets or sets the headers. ,
Required: False ,
}
object ,
}
,
queueMessage:
{
Description: Gets or sets the storage queue message. ,
Required: False ,
}
{
storageAccount:
{
Description: Gets or sets the storage account name. ,
Required: False ,
}
string ,
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
sasToken:
{
Description: Gets or sets the SAS key. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message. ,
Required: False ,
}
string ,
}
,
serviceBusQueueMessage:
{
Description: Gets or sets the service bus queue message. ,
Required: False ,
}
{
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
}
,
serviceBusTopicMessage:
{
Description: Gets or sets the service bus topic message. ,
Required: False ,
}
{
topicPath:
{
Description: Gets or sets the topic path. ,
Required: False ,
}
string ,
}
,
retryPolicy:
{
Description: Gets or sets the retry policy. ,
Required: False ,
}
{
retryType:
{
Description: Gets or sets the retry strategy to be used. ,
Enum:
{
None: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
retryInterval:
{
Description: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets or sets the number of times a retry should be attempted. ,
Required: False ,
}
integer ,
}
,
errorAction:
{
Description: Gets or sets the error action. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the job error action type. ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
StorageQueue: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
}
,
Required: False ,
}
enum ,
request:
{
Description: Gets or sets the http requests. ,
Required: False ,
}
{
authentication:
{
Description: Gets or sets the authentication method of the request. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the HTTP authentication type. ,
Enum:
{
NotSpecified: No description available. ,
ClientCertificate: No description available. ,
ActiveDirectoryOAuth: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
uri:
{
Description: Gets or sets the URI of the request. ,
Required: False ,
}
string ,
method:
{
Description: Gets or sets the method of the request. ,
Required: False ,
}
string ,
body:
{
Description: Gets or sets the request body. ,
Required: False ,
}
string ,
headers:
{
Description: Gets or sets the headers. ,
Required: False ,
}
object ,
}
,
queueMessage:
{
Description: Gets or sets the storage queue message. ,
Required: False ,
}
{
storageAccount:
{
Description: Gets or sets the storage account name. ,
Required: False ,
}
string ,
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
sasToken:
{
Description: Gets or sets the SAS key. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message. ,
Required: False ,
}
string ,
}
,
serviceBusQueueMessage:
{
Description: Gets or sets the service bus queue message. ,
Required: False ,
}
{
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
}
,
serviceBusTopicMessage:
{
Description: Gets or sets the service bus topic message. ,
Required: False ,
}
{
topicPath:
{
Description: Gets or sets the topic path. ,
Required: False ,
}
string ,
}
,
retryPolicy:
{
Description: Gets or sets the retry policy. ,
Required: False ,
}
{
retryType:
{
Description: Gets or sets the retry strategy to be used. ,
Enum:
{
None: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
retryInterval:
{
Description: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets or sets the number of times a retry should be attempted. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
recurrence:
{
Description: Gets or sets the job recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
count:
{
Description: Gets or sets the maximum number of times that the job should run. ,
Required: False ,
}
integer ,
endTime:
{
Description: Gets or sets the time at which the job will complete. ,
Format: date-time ,
Required: False ,
}
string ,
schedule:
{
Required: False ,
}
{
weekDays:
{
Description: Gets or sets the days of the week that the job should execute on. ,
Required: False ,
}
[
string ,
]
,
hours:
{
Description: Gets or sets the hours of the day that the job should execute at. ,
Required: False ,
}
[
integer ,
]
,
minutes:
{
Description: Gets or sets the minutes of the hour that the job should execute at. ,
Required: False ,
}
[
integer ,
]
,
monthDays:
{
Description: Gets or sets the days of the month that the job should execute on. Must be between 1 and 31. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: Gets or sets the occurrences of days within a month. ,
Required: False ,
}
[
{
day:
{
Description: Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
Occurrence:
{
Description: Gets or sets the occurrence. Must be between -5 and 5. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
state:
{
Description: Gets or set the job state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Faulted: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Gets the job status. ,
Required: False ,
}
{
executionCount:
{
Description: Gets the number of times this job has executed. ,
Required: False ,
}
integer ,
failureCount:
{
Description: Gets the number of times this job has failed. ,
Required: False ,
}
integer ,
faultedCount:
{
Description: Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states). ,
Required: False ,
}
integer ,
lastExecutionTime:
{
Description: Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet. ,
Format: date-time ,
Required: False ,
}
string ,
nextExecutionTime:
{
Description: Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
Jobs_CreateOrUpdate (removed)
Description :  Provisions a new job or updates an existing job.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
jobCollectionName:
{
Description: The job collection name. ,
Required: True ,
}
string ,
jobName:
{
Description: The job name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
job:
{
Description: The job definition. ,
Required: True ,
}
{
id:
{
Description: Gets the job resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets the job resource name. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the job properties. ,
Required: False ,
}
{
startTime:
{
Description: Gets or sets the job start time. ,
Format: date-time ,
Required: False ,
}
string ,
action:
{
Description: Gets or sets the job action. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the job action type. ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
StorageQueue: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
}
,
Required: False ,
}
enum ,
request:
{
Description: Gets or sets the http requests. ,
Required: False ,
}
{
authentication:
{
Description: Gets or sets the authentication method of the request. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the HTTP authentication type. ,
Enum:
{
NotSpecified: No description available. ,
ClientCertificate: No description available. ,
ActiveDirectoryOAuth: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
uri:
{
Description: Gets or sets the URI of the request. ,
Required: False ,
}
string ,
method:
{
Description: Gets or sets the method of the request. ,
Required: False ,
}
string ,
body:
{
Description: Gets or sets the request body. ,
Required: False ,
}
string ,
headers:
{
Description: Gets or sets the headers. ,
Required: False ,
}
object ,
}
,
queueMessage:
{
Description: Gets or sets the storage queue message. ,
Required: False ,
}
{
storageAccount:
{
Description: Gets or sets the storage account name. ,
Required: False ,
}
string ,
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
sasToken:
{
Description: Gets or sets the SAS key. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message. ,
Required: False ,
}
string ,
}
,
serviceBusQueueMessage:
{
Description: Gets or sets the service bus queue message. ,
Required: False ,
}
{
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
}
,
serviceBusTopicMessage:
{
Description: Gets or sets the service bus topic message. ,
Required: False ,
}
{
topicPath:
{
Description: Gets or sets the topic path. ,
Required: False ,
}
string ,
}
,
retryPolicy:
{
Description: Gets or sets the retry policy. ,
Required: False ,
}
{
retryType:
{
Description: Gets or sets the retry strategy to be used. ,
Enum:
{
None: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
retryInterval:
{
Description: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets or sets the number of times a retry should be attempted. ,
Required: False ,
}
integer ,
}
,
errorAction:
{
Description: Gets or sets the error action. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the job error action type. ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
StorageQueue: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
}
,
Required: False ,
}
enum ,
request:
{
Description: Gets or sets the http requests. ,
Required: False ,
}
{
authentication:
{
Description: Gets or sets the authentication method of the request. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the HTTP authentication type. ,
Enum:
{
NotSpecified: No description available. ,
ClientCertificate: No description available. ,
ActiveDirectoryOAuth: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
uri:
{
Description: Gets or sets the URI of the request. ,
Required: False ,
}
string ,
method:
{
Description: Gets or sets the method of the request. ,
Required: False ,
}
string ,
body:
{
Description: Gets or sets the request body. ,
Required: False ,
}
string ,
headers:
{
Description: Gets or sets the headers. ,
Required: False ,
}
object ,
}
,
queueMessage:
{
Description: Gets or sets the storage queue message. ,
Required: False ,
}
{
storageAccount:
{
Description: Gets or sets the storage account name. ,
Required: False ,
}
string ,
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
sasToken:
{
Description: Gets or sets the SAS key. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message. ,
Required: False ,
}
string ,
}
,
serviceBusQueueMessage:
{
Description: Gets or sets the service bus queue message. ,
Required: False ,
}
{
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
}
,
serviceBusTopicMessage:
{
Description: Gets or sets the service bus topic message. ,
Required: False ,
}
{
topicPath:
{
Description: Gets or sets the topic path. ,
Required: False ,
}
string ,
}
,
retryPolicy:
{
Description: Gets or sets the retry policy. ,
Required: False ,
}
{
retryType:
{
Description: Gets or sets the retry strategy to be used. ,
Enum:
{
None: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
retryInterval:
{
Description: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets or sets the number of times a retry should be attempted. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
recurrence:
{
Description: Gets or sets the job recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
count:
{
Description: Gets or sets the maximum number of times that the job should run. ,
Required: False ,
}
integer ,
endTime:
{
Description: Gets or sets the time at which the job will complete. ,
Format: date-time ,
Required: False ,
}
string ,
schedule:
{
Required: False ,
}
{
weekDays:
{
Description: Gets or sets the days of the week that the job should execute on. ,
Required: False ,
}
[
string ,
]
,
hours:
{
Description: Gets or sets the hours of the day that the job should execute at. ,
Required: False ,
}
[
integer ,
]
,
minutes:
{
Description: Gets or sets the minutes of the hour that the job should execute at. ,
Required: False ,
}
[
integer ,
]
,
monthDays:
{
Description: Gets or sets the days of the month that the job should execute on. Must be between 1 and 31. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: Gets or sets the occurrences of days within a month. ,
Required: False ,
}
[
{
day:
{
Description: Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
Occurrence:
{
Description: Gets or sets the occurrence. Must be between -5 and 5. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
state:
{
Description: Gets or set the job state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Faulted: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Gets the job status. ,
Required: False ,
}
{
executionCount:
{
Description: Gets the number of times this job has executed. ,
Required: False ,
}
integer ,
failureCount:
{
Description: Gets the number of times this job has failed. ,
Required: False ,
}
integer ,
faultedCount:
{
Description: Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states). ,
Required: False ,
}
integer ,
lastExecutionTime:
{
Description: Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet. ,
Format: date-time ,
Required: False ,
}
string ,
nextExecutionTime:
{
Description: Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Gets the job resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets the job resource name. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the job properties. ,
Required: False ,
}
{
startTime:
{
Description: Gets or sets the job start time. ,
Format: date-time ,
Required: False ,
}
string ,
action:
{
Description: Gets or sets the job action. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the job action type. ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
StorageQueue: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
}
,
Required: False ,
}
enum ,
request:
{
Description: Gets or sets the http requests. ,
Required: False ,
}
{
authentication:
{
Description: Gets or sets the authentication method of the request. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the HTTP authentication type. ,
Enum:
{
NotSpecified: No description available. ,
ClientCertificate: No description available. ,
ActiveDirectoryOAuth: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
uri:
{
Description: Gets or sets the URI of the request. ,
Required: False ,
}
string ,
method:
{
Description: Gets or sets the method of the request. ,
Required: False ,
}
string ,
body:
{
Description: Gets or sets the request body. ,
Required: False ,
}
string ,
headers:
{
Description: Gets or sets the headers. ,
Required: False ,
}
object ,
}
,
queueMessage:
{
Description: Gets or sets the storage queue message. ,
Required: False ,
}
{
storageAccount:
{
Description: Gets or sets the storage account name. ,
Required: False ,
}
string ,
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
sasToken:
{
Description: Gets or sets the SAS key. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message. ,
Required: False ,
}
string ,
}
,
serviceBusQueueMessage:
{
Description: Gets or sets the service bus queue message. ,
Required: False ,
}
{
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
}
,
serviceBusTopicMessage:
{
Description: Gets or sets the service bus topic message. ,
Required: False ,
}
{
topicPath:
{
Description: Gets or sets the topic path. ,
Required: False ,
}
string ,
}
,
retryPolicy:
{
Description: Gets or sets the retry policy. ,
Required: False ,
}
{
retryType:
{
Description: Gets or sets the retry strategy to be used. ,
Enum:
{
None: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
retryInterval:
{
Description: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets or sets the number of times a retry should be attempted. ,
Required: False ,
}
integer ,
}
,
errorAction:
{
Description: Gets or sets the error action. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the job error action type. ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
StorageQueue: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
}
,
Required: False ,
}
enum ,
request:
{
Description: Gets or sets the http requests. ,
Required: False ,
}
{
authentication:
{
Description: Gets or sets the authentication method of the request. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the HTTP authentication type. ,
Enum:
{
NotSpecified: No description available. ,
ClientCertificate: No description available. ,
ActiveDirectoryOAuth: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
uri:
{
Description: Gets or sets the URI of the request. ,
Required: False ,
}
string ,
method:
{
Description: Gets or sets the method of the request. ,
Required: False ,
}
string ,
body:
{
Description: Gets or sets the request body. ,
Required: False ,
}
string ,
headers:
{
Description: Gets or sets the headers. ,
Required: False ,
}
object ,
}
,
queueMessage:
{
Description: Gets or sets the storage queue message. ,
Required: False ,
}
{
storageAccount:
{
Description: Gets or sets the storage account name. ,
Required: False ,
}
string ,
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
sasToken:
{
Description: Gets or sets the SAS key. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message. ,
Required: False ,
}
string ,
}
,
serviceBusQueueMessage:
{
Description: Gets or sets the service bus queue message. ,
Required: False ,
}
{
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
}
,
serviceBusTopicMessage:
{
Description: Gets or sets the service bus topic message. ,
Required: False ,
}
{
topicPath:
{
Description: Gets or sets the topic path. ,
Required: False ,
}
string ,
}
,
retryPolicy:
{
Description: Gets or sets the retry policy. ,
Required: False ,
}
{
retryType:
{
Description: Gets or sets the retry strategy to be used. ,
Enum:
{
None: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
retryInterval:
{
Description: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets or sets the number of times a retry should be attempted. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
recurrence:
{
Description: Gets or sets the job recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
count:
{
Description: Gets or sets the maximum number of times that the job should run. ,
Required: False ,
}
integer ,
endTime:
{
Description: Gets or sets the time at which the job will complete. ,
Format: date-time ,
Required: False ,
}
string ,
schedule:
{
Required: False ,
}
{
weekDays:
{
Description: Gets or sets the days of the week that the job should execute on. ,
Required: False ,
}
[
string ,
]
,
hours:
{
Description: Gets or sets the hours of the day that the job should execute at. ,
Required: False ,
}
[
integer ,
]
,
minutes:
{
Description: Gets or sets the minutes of the hour that the job should execute at. ,
Required: False ,
}
[
integer ,
]
,
monthDays:
{
Description: Gets or sets the days of the month that the job should execute on. Must be between 1 and 31. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: Gets or sets the occurrences of days within a month. ,
Required: False ,
}
[
{
day:
{
Description: Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
Occurrence:
{
Description: Gets or sets the occurrence. Must be between -5 and 5. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
state:
{
Description: Gets or set the job state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Faulted: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Gets the job status. ,
Required: False ,
}
{
executionCount:
{
Description: Gets the number of times this job has executed. ,
Required: False ,
}
integer ,
failureCount:
{
Description: Gets the number of times this job has failed. ,
Required: False ,
}
integer ,
faultedCount:
{
Description: Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states). ,
Required: False ,
}
integer ,
lastExecutionTime:
{
Description: Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet. ,
Format: date-time ,
Required: False ,
}
string ,
nextExecutionTime:
{
Description: Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
id:
{
Description: Gets the job resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets the job resource name. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the job properties. ,
Required: False ,
}
{
startTime:
{
Description: Gets or sets the job start time. ,
Format: date-time ,
Required: False ,
}
string ,
action:
{
Description: Gets or sets the job action. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the job action type. ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
StorageQueue: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
}
,
Required: False ,
}
enum ,
request:
{
Description: Gets or sets the http requests. ,
Required: False ,
}
{
authentication:
{
Description: Gets or sets the authentication method of the request. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the HTTP authentication type. ,
Enum:
{
NotSpecified: No description available. ,
ClientCertificate: No description available. ,
ActiveDirectoryOAuth: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
uri:
{
Description: Gets or sets the URI of the request. ,
Required: False ,
}
string ,
method:
{
Description: Gets or sets the method of the request. ,
Required: False ,
}
string ,
body:
{
Description: Gets or sets the request body. ,
Required: False ,
}
string ,
headers:
{
Description: Gets or sets the headers. ,
Required: False ,
}
object ,
}
,
queueMessage:
{
Description: Gets or sets the storage queue message. ,
Required: False ,
}
{
storageAccount:
{
Description: Gets or sets the storage account name. ,
Required: False ,
}
string ,
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
sasToken:
{
Description: Gets or sets the SAS key. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message. ,
Required: False ,
}
string ,
}
,
serviceBusQueueMessage:
{
Description: Gets or sets the service bus queue message. ,
Required: False ,
}
{
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
}
,
serviceBusTopicMessage:
{
Description: Gets or sets the service bus topic message. ,
Required: False ,
}
{
topicPath:
{
Description: Gets or sets the topic path. ,
Required: False ,
}
string ,
}
,
retryPolicy:
{
Description: Gets or sets the retry policy. ,
Required: False ,
}
{
retryType:
{
Description: Gets or sets the retry strategy to be used. ,
Enum:
{
None: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
retryInterval:
{
Description: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets or sets the number of times a retry should be attempted. ,
Required: False ,
}
integer ,
}
,
errorAction:
{
Description: Gets or sets the error action. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the job error action type. ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
StorageQueue: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
}
,
Required: False ,
}
enum ,
request:
{
Description: Gets or sets the http requests. ,
Required: False ,
}
{
authentication:
{
Description: Gets or sets the authentication method of the request. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the HTTP authentication type. ,
Enum:
{
NotSpecified: No description available. ,
ClientCertificate: No description available. ,
ActiveDirectoryOAuth: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
uri:
{
Description: Gets or sets the URI of the request. ,
Required: False ,
}
string ,
method:
{
Description: Gets or sets the method of the request. ,
Required: False ,
}
string ,
body:
{
Description: Gets or sets the request body. ,
Required: False ,
}
string ,
headers:
{
Description: Gets or sets the headers. ,
Required: False ,
}
object ,
}
,
queueMessage:
{
Description: Gets or sets the storage queue message. ,
Required: False ,
}
{
storageAccount:
{
Description: Gets or sets the storage account name. ,
Required: False ,
}
string ,
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
sasToken:
{
Description: Gets or sets the SAS key. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message. ,
Required: False ,
}
string ,
}
,
serviceBusQueueMessage:
{
Description: Gets or sets the service bus queue message. ,
Required: False ,
}
{
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
}
,
serviceBusTopicMessage:
{
Description: Gets or sets the service bus topic message. ,
Required: False ,
}
{
topicPath:
{
Description: Gets or sets the topic path. ,
Required: False ,
}
string ,
}
,
retryPolicy:
{
Description: Gets or sets the retry policy. ,
Required: False ,
}
{
retryType:
{
Description: Gets or sets the retry strategy to be used. ,
Enum:
{
None: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
retryInterval:
{
Description: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets or sets the number of times a retry should be attempted. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
recurrence:
{
Description: Gets or sets the job recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
count:
{
Description: Gets or sets the maximum number of times that the job should run. ,
Required: False ,
}
integer ,
endTime:
{
Description: Gets or sets the time at which the job will complete. ,
Format: date-time ,
Required: False ,
}
string ,
schedule:
{
Required: False ,
}
{
weekDays:
{
Description: Gets or sets the days of the week that the job should execute on. ,
Required: False ,
}
[
string ,
]
,
hours:
{
Description: Gets or sets the hours of the day that the job should execute at. ,
Required: False ,
}
[
integer ,
]
,
minutes:
{
Description: Gets or sets the minutes of the hour that the job should execute at. ,
Required: False ,
}
[
integer ,
]
,
monthDays:
{
Description: Gets or sets the days of the month that the job should execute on. Must be between 1 and 31. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: Gets or sets the occurrences of days within a month. ,
Required: False ,
}
[
{
day:
{
Description: Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
Occurrence:
{
Description: Gets or sets the occurrence. Must be between -5 and 5. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
state:
{
Description: Gets or set the job state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Faulted: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Gets the job status. ,
Required: False ,
}
{
executionCount:
{
Description: Gets the number of times this job has executed. ,
Required: False ,
}
integer ,
failureCount:
{
Description: Gets the number of times this job has failed. ,
Required: False ,
}
integer ,
faultedCount:
{
Description: Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states). ,
Required: False ,
}
integer ,
lastExecutionTime:
{
Description: Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet. ,
Format: date-time ,
Required: False ,
}
string ,
nextExecutionTime:
{
Description: Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
Jobs_Patch (removed)
Description :  Patches an existing job.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
jobCollectionName:
{
Description: The job collection name. ,
Required: True ,
}
string ,
jobName:
{
Description: The job name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
job:
{
Description: The job definition. ,
Required: True ,
}
{
id:
{
Description: Gets the job resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets the job resource name. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the job properties. ,
Required: False ,
}
{
startTime:
{
Description: Gets or sets the job start time. ,
Format: date-time ,
Required: False ,
}
string ,
action:
{
Description: Gets or sets the job action. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the job action type. ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
StorageQueue: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
}
,
Required: False ,
}
enum ,
request:
{
Description: Gets or sets the http requests. ,
Required: False ,
}
{
authentication:
{
Description: Gets or sets the authentication method of the request. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the HTTP authentication type. ,
Enum:
{
NotSpecified: No description available. ,
ClientCertificate: No description available. ,
ActiveDirectoryOAuth: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
uri:
{
Description: Gets or sets the URI of the request. ,
Required: False ,
}
string ,
method:
{
Description: Gets or sets the method of the request. ,
Required: False ,
}
string ,
body:
{
Description: Gets or sets the request body. ,
Required: False ,
}
string ,
headers:
{
Description: Gets or sets the headers. ,
Required: False ,
}
object ,
}
,
queueMessage:
{
Description: Gets or sets the storage queue message. ,
Required: False ,
}
{
storageAccount:
{
Description: Gets or sets the storage account name. ,
Required: False ,
}
string ,
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
sasToken:
{
Description: Gets or sets the SAS key. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message. ,
Required: False ,
}
string ,
}
,
serviceBusQueueMessage:
{
Description: Gets or sets the service bus queue message. ,
Required: False ,
}
{
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
}
,
serviceBusTopicMessage:
{
Description: Gets or sets the service bus topic message. ,
Required: False ,
}
{
topicPath:
{
Description: Gets or sets the topic path. ,
Required: False ,
}
string ,
}
,
retryPolicy:
{
Description: Gets or sets the retry policy. ,
Required: False ,
}
{
retryType:
{
Description: Gets or sets the retry strategy to be used. ,
Enum:
{
None: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
retryInterval:
{
Description: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets or sets the number of times a retry should be attempted. ,
Required: False ,
}
integer ,
}
,
errorAction:
{
Description: Gets or sets the error action. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the job error action type. ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
StorageQueue: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
}
,
Required: False ,
}
enum ,
request:
{
Description: Gets or sets the http requests. ,
Required: False ,
}
{
authentication:
{
Description: Gets or sets the authentication method of the request. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the HTTP authentication type. ,
Enum:
{
NotSpecified: No description available. ,
ClientCertificate: No description available. ,
ActiveDirectoryOAuth: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
uri:
{
Description: Gets or sets the URI of the request. ,
Required: False ,
}
string ,
method:
{
Description: Gets or sets the method of the request. ,
Required: False ,
}
string ,
body:
{
Description: Gets or sets the request body. ,
Required: False ,
}
string ,
headers:
{
Description: Gets or sets the headers. ,
Required: False ,
}
object ,
}
,
queueMessage:
{
Description: Gets or sets the storage queue message. ,
Required: False ,
}
{
storageAccount:
{
Description: Gets or sets the storage account name. ,
Required: False ,
}
string ,
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
sasToken:
{
Description: Gets or sets the SAS key. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message. ,
Required: False ,
}
string ,
}
,
serviceBusQueueMessage:
{
Description: Gets or sets the service bus queue message. ,
Required: False ,
}
{
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
}
,
serviceBusTopicMessage:
{
Description: Gets or sets the service bus topic message. ,
Required: False ,
}
{
topicPath:
{
Description: Gets or sets the topic path. ,
Required: False ,
}
string ,
}
,
retryPolicy:
{
Description: Gets or sets the retry policy. ,
Required: False ,
}
{
retryType:
{
Description: Gets or sets the retry strategy to be used. ,
Enum:
{
None: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
retryInterval:
{
Description: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets or sets the number of times a retry should be attempted. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
recurrence:
{
Description: Gets or sets the job recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
count:
{
Description: Gets or sets the maximum number of times that the job should run. ,
Required: False ,
}
integer ,
endTime:
{
Description: Gets or sets the time at which the job will complete. ,
Format: date-time ,
Required: False ,
}
string ,
schedule:
{
Required: False ,
}
{
weekDays:
{
Description: Gets or sets the days of the week that the job should execute on. ,
Required: False ,
}
[
string ,
]
,
hours:
{
Description: Gets or sets the hours of the day that the job should execute at. ,
Required: False ,
}
[
integer ,
]
,
minutes:
{
Description: Gets or sets the minutes of the hour that the job should execute at. ,
Required: False ,
}
[
integer ,
]
,
monthDays:
{
Description: Gets or sets the days of the month that the job should execute on. Must be between 1 and 31. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: Gets or sets the occurrences of days within a month. ,
Required: False ,
}
[
{
day:
{
Description: Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
Occurrence:
{
Description: Gets or sets the occurrence. Must be between -5 and 5. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
state:
{
Description: Gets or set the job state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Faulted: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Gets the job status. ,
Required: False ,
}
{
executionCount:
{
Description: Gets the number of times this job has executed. ,
Required: False ,
}
integer ,
failureCount:
{
Description: Gets the number of times this job has failed. ,
Required: False ,
}
integer ,
faultedCount:
{
Description: Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states). ,
Required: False ,
}
integer ,
lastExecutionTime:
{
Description: Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet. ,
Format: date-time ,
Required: False ,
}
string ,
nextExecutionTime:
{
Description: Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Gets the job resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets the job resource name. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the job properties. ,
Required: False ,
}
{
startTime:
{
Description: Gets or sets the job start time. ,
Format: date-time ,
Required: False ,
}
string ,
action:
{
Description: Gets or sets the job action. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the job action type. ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
StorageQueue: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
}
,
Required: False ,
}
enum ,
request:
{
Description: Gets or sets the http requests. ,
Required: False ,
}
{
authentication:
{
Description: Gets or sets the authentication method of the request. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the HTTP authentication type. ,
Enum:
{
NotSpecified: No description available. ,
ClientCertificate: No description available. ,
ActiveDirectoryOAuth: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
uri:
{
Description: Gets or sets the URI of the request. ,
Required: False ,
}
string ,
method:
{
Description: Gets or sets the method of the request. ,
Required: False ,
}
string ,
body:
{
Description: Gets or sets the request body. ,
Required: False ,
}
string ,
headers:
{
Description: Gets or sets the headers. ,
Required: False ,
}
object ,
}
,
queueMessage:
{
Description: Gets or sets the storage queue message. ,
Required: False ,
}
{
storageAccount:
{
Description: Gets or sets the storage account name. ,
Required: False ,
}
string ,
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
sasToken:
{
Description: Gets or sets the SAS key. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message. ,
Required: False ,
}
string ,
}
,
serviceBusQueueMessage:
{
Description: Gets or sets the service bus queue message. ,
Required: False ,
}
{
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
}
,
serviceBusTopicMessage:
{
Description: Gets or sets the service bus topic message. ,
Required: False ,
}
{
topicPath:
{
Description: Gets or sets the topic path. ,
Required: False ,
}
string ,
}
,
retryPolicy:
{
Description: Gets or sets the retry policy. ,
Required: False ,
}
{
retryType:
{
Description: Gets or sets the retry strategy to be used. ,
Enum:
{
None: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
retryInterval:
{
Description: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets or sets the number of times a retry should be attempted. ,
Required: False ,
}
integer ,
}
,
errorAction:
{
Description: Gets or sets the error action. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the job error action type. ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
StorageQueue: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
}
,
Required: False ,
}
enum ,
request:
{
Description: Gets or sets the http requests. ,
Required: False ,
}
{
authentication:
{
Description: Gets or sets the authentication method of the request. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the HTTP authentication type. ,
Enum:
{
NotSpecified: No description available. ,
ClientCertificate: No description available. ,
ActiveDirectoryOAuth: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
uri:
{
Description: Gets or sets the URI of the request. ,
Required: False ,
}
string ,
method:
{
Description: Gets or sets the method of the request. ,
Required: False ,
}
string ,
body:
{
Description: Gets or sets the request body. ,
Required: False ,
}
string ,
headers:
{
Description: Gets or sets the headers. ,
Required: False ,
}
object ,
}
,
queueMessage:
{
Description: Gets or sets the storage queue message. ,
Required: False ,
}
{
storageAccount:
{
Description: Gets or sets the storage account name. ,
Required: False ,
}
string ,
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
sasToken:
{
Description: Gets or sets the SAS key. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message. ,
Required: False ,
}
string ,
}
,
serviceBusQueueMessage:
{
Description: Gets or sets the service bus queue message. ,
Required: False ,
}
{
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
}
,
serviceBusTopicMessage:
{
Description: Gets or sets the service bus topic message. ,
Required: False ,
}
{
topicPath:
{
Description: Gets or sets the topic path. ,
Required: False ,
}
string ,
}
,
retryPolicy:
{
Description: Gets or sets the retry policy. ,
Required: False ,
}
{
retryType:
{
Description: Gets or sets the retry strategy to be used. ,
Enum:
{
None: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
retryInterval:
{
Description: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets or sets the number of times a retry should be attempted. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
recurrence:
{
Description: Gets or sets the job recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
count:
{
Description: Gets or sets the maximum number of times that the job should run. ,
Required: False ,
}
integer ,
endTime:
{
Description: Gets or sets the time at which the job will complete. ,
Format: date-time ,
Required: False ,
}
string ,
schedule:
{
Required: False ,
}
{
weekDays:
{
Description: Gets or sets the days of the week that the job should execute on. ,
Required: False ,
}
[
string ,
]
,
hours:
{
Description: Gets or sets the hours of the day that the job should execute at. ,
Required: False ,
}
[
integer ,
]
,
minutes:
{
Description: Gets or sets the minutes of the hour that the job should execute at. ,
Required: False ,
}
[
integer ,
]
,
monthDays:
{
Description: Gets or sets the days of the month that the job should execute on. Must be between 1 and 31. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: Gets or sets the occurrences of days within a month. ,
Required: False ,
}
[
{
day:
{
Description: Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
Occurrence:
{
Description: Gets or sets the occurrence. Must be between -5 and 5. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
state:
{
Description: Gets or set the job state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Faulted: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Gets the job status. ,
Required: False ,
}
{
executionCount:
{
Description: Gets the number of times this job has executed. ,
Required: False ,
}
integer ,
failureCount:
{
Description: Gets the number of times this job has failed. ,
Required: False ,
}
integer ,
faultedCount:
{
Description: Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states). ,
Required: False ,
}
integer ,
lastExecutionTime:
{
Description: Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet. ,
Format: date-time ,
Required: False ,
}
string ,
nextExecutionTime:
{
Description: Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
Jobs_Delete (removed)
Description :  Deletes a job.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
jobCollectionName:
{
Description: The job collection name. ,
Required: True ,
}
string ,
jobName:
{
Description: The job name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
Jobs_Run (removed)
Description :  Runs a job.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}/run
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
jobCollectionName:
{
Description: The job collection name. ,
Required: True ,
}
string ,
jobName:
{
Description: The job name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
Jobs_List (removed)
Description :  Lists all jobs under the specified job collection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
jobCollectionName:
{
Description: The job collection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
$top:
{
Description: The number of jobs to request, in the of range of [1..100]. ,
Required: False ,
}
integer ,
$skip:
{
Description: The (0-based) index of the job history list from which to begin requesting entries. ,
Required: False ,
}
integer ,
$filter:
{
Description: The filter to apply on the job state. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets all jobs under job collection. ,
Required: False ,
}
[
{
id:
{
Description: Gets the job resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets the job resource name. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the job properties. ,
Required: False ,
}
{
startTime:
{
Description: Gets or sets the job start time. ,
Format: date-time ,
Required: False ,
}
string ,
action:
{
Description: Gets or sets the job action. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the job action type. ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
StorageQueue: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
}
,
Required: False ,
}
enum ,
request:
{
Description: Gets or sets the http requests. ,
Required: False ,
}
{
authentication:
{
Description: Gets or sets the authentication method of the request. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the HTTP authentication type. ,
Enum:
{
NotSpecified: No description available. ,
ClientCertificate: No description available. ,
ActiveDirectoryOAuth: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
uri:
{
Description: Gets or sets the URI of the request. ,
Required: False ,
}
string ,
method:
{
Description: Gets or sets the method of the request. ,
Required: False ,
}
string ,
body:
{
Description: Gets or sets the request body. ,
Required: False ,
}
string ,
headers:
{
Description: Gets or sets the headers. ,
Required: False ,
}
object ,
}
,
queueMessage:
{
Description: Gets or sets the storage queue message. ,
Required: False ,
}
{
storageAccount:
{
Description: Gets or sets the storage account name. ,
Required: False ,
}
string ,
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
sasToken:
{
Description: Gets or sets the SAS key. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message. ,
Required: False ,
}
string ,
}
,
serviceBusQueueMessage:
{
Description: Gets or sets the service bus queue message. ,
Required: False ,
}
{
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
}
,
serviceBusTopicMessage:
{
Description: Gets or sets the service bus topic message. ,
Required: False ,
}
{
topicPath:
{
Description: Gets or sets the topic path. ,
Required: False ,
}
string ,
}
,
retryPolicy:
{
Description: Gets or sets the retry policy. ,
Required: False ,
}
{
retryType:
{
Description: Gets or sets the retry strategy to be used. ,
Enum:
{
None: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
retryInterval:
{
Description: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets or sets the number of times a retry should be attempted. ,
Required: False ,
}
integer ,
}
,
errorAction:
{
Description: Gets or sets the error action. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the job error action type. ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
StorageQueue: No description available. ,
ServiceBusQueue: No description available. ,
ServiceBusTopic: No description available. ,
}
,
Required: False ,
}
enum ,
request:
{
Description: Gets or sets the http requests. ,
Required: False ,
}
{
authentication:
{
Description: Gets or sets the authentication method of the request. ,
Required: False ,
}
{
type:
{
Description: Gets or sets the HTTP authentication type. ,
Enum:
{
NotSpecified: No description available. ,
ClientCertificate: No description available. ,
ActiveDirectoryOAuth: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
uri:
{
Description: Gets or sets the URI of the request. ,
Required: False ,
}
string ,
method:
{
Description: Gets or sets the method of the request. ,
Required: False ,
}
string ,
body:
{
Description: Gets or sets the request body. ,
Required: False ,
}
string ,
headers:
{
Description: Gets or sets the headers. ,
Required: False ,
}
object ,
}
,
queueMessage:
{
Description: Gets or sets the storage queue message. ,
Required: False ,
}
{
storageAccount:
{
Description: Gets or sets the storage account name. ,
Required: False ,
}
string ,
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
sasToken:
{
Description: Gets or sets the SAS key. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the message. ,
Required: False ,
}
string ,
}
,
serviceBusQueueMessage:
{
Description: Gets or sets the service bus queue message. ,
Required: False ,
}
{
queueName:
{
Description: Gets or sets the queue name. ,
Required: False ,
}
string ,
}
,
serviceBusTopicMessage:
{
Description: Gets or sets the service bus topic message. ,
Required: False ,
}
{
topicPath:
{
Description: Gets or sets the topic path. ,
Required: False ,
}
string ,
}
,
retryPolicy:
{
Description: Gets or sets the retry policy. ,
Required: False ,
}
{
retryType:
{
Description: Gets or sets the retry strategy to be used. ,
Enum:
{
None: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
retryInterval:
{
Description: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets or sets the number of times a retry should be attempted. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
recurrence:
{
Description: Gets or sets the job recurrence. ,
Required: False ,
}
{
frequency:
{
Description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Gets or sets the interval between retries. ,
Required: False ,
}
integer ,
count:
{
Description: Gets or sets the maximum number of times that the job should run. ,
Required: False ,
}
integer ,
endTime:
{
Description: Gets or sets the time at which the job will complete. ,
Format: date-time ,
Required: False ,
}
string ,
schedule:
{
Required: False ,
}
{
weekDays:
{
Description: Gets or sets the days of the week that the job should execute on. ,
Required: False ,
}
[
string ,
]
,
hours:
{
Description: Gets or sets the hours of the day that the job should execute at. ,
Required: False ,
}
[
integer ,
]
,
minutes:
{
Description: Gets or sets the minutes of the hour that the job should execute at. ,
Required: False ,
}
[
integer ,
]
,
monthDays:
{
Description: Gets or sets the days of the month that the job should execute on. Must be between 1 and 31. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: Gets or sets the occurrences of days within a month. ,
Required: False ,
}
[
{
day:
{
Description: Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
Occurrence:
{
Description: Gets or sets the occurrence. Must be between -5 and 5. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
state:
{
Description: Gets or set the job state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Faulted: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Gets the job status. ,
Required: False ,
}
{
executionCount:
{
Description: Gets the number of times this job has executed. ,
Required: False ,
}
integer ,
failureCount:
{
Description: Gets the number of times this job has failed. ,
Required: False ,
}
integer ,
faultedCount:
{
Description: Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states). ,
Required: False ,
}
integer ,
lastExecutionTime:
{
Description: Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet. ,
Format: date-time ,
Required: False ,
}
string ,
nextExecutionTime:
{
Description: Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets the URL to get the next set of jobs. ,
Required: False ,
}
string ,
}
Jobs_ListJobHistory (removed)
Description :  Lists job history.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}/history
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
jobCollectionName:
{
Description: The job collection name. ,
Required: True ,
}
string ,
jobName:
{
Description: The job name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
$top:
{
Description: the number of job history to request, in the of range of [1..100]. ,
Required: False ,
}
integer ,
$skip:
{
Description: The (0-based) index of the job history list from which to begin requesting entries. ,
Required: False ,
}
integer ,
$filter:
{
Description: The filter to apply on the job state. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the job histories under job. ,
Required: False ,
}
[
{
id:
{
Description: Gets the job history identifier. ,
Required: False ,
}
string ,
type:
{
Description: Gets the job history resource type. ,
Required: False ,
}
string ,
name:
{
Description: Gets the job history name. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the job history properties. ,
Required: False ,
}
{
startTime:
{
Description: Gets the start time for this job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time for this job. ,
Format: date-time ,
Required: False ,
}
string ,
expectedExecutionTime:
{
Description: Gets the expected execution time for this job. ,
Format: date-time ,
Required: False ,
}
string ,
actionName:
{
Description: Gets the job history action name. ,
Enum:
{
MainAction: No description available. ,
ErrorAction: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Gets the job history status. ,
Enum:
{
Completed: No description available. ,
Failed: No description available. ,
Postponed: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Gets the message for the job history. ,
Required: False ,
}
string ,
retryCount:
{
Description: Gets the retry count for job. ,
Required: False ,
}
integer ,
repeatCount:
{
Description: Gets the repeat count for the job. ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets the URL to get the next set of job histories. ,
Required: False ,
}
string ,
}