5.0.0 • Published 5 years ago
@datafire/azure_scheduler v5.0.0
@datafire/azure_scheduler
Client library for SchedulerManagementClient
Installation and Usage
npm install --save @datafire/azure_scheduler
let azure_scheduler = require('@datafire/azure_scheduler').create();
.then(data => {
console.log(data);
});
Description
Actions
JobCollections_ListBySubscription
Gets all job collections under specified subscription.
azure_scheduler.JobCollections_ListBySubscription({
"subscriptionId": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription id. - api-version required
string
: The API version.
- subscriptionId required
Output
- output JobCollectionListResult
JobCollections_ListByResourceGroup
Gets all job collections under specified resource group.
azure_scheduler.JobCollections_ListByResourceGroup({
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription id. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- subscriptionId required
Output
- output JobCollectionListResult
JobCollections_Delete
Deletes a job collection.
azure_scheduler.JobCollections_Delete({
"subscriptionId": "",
"resourceGroupName": "",
"jobCollectionName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription id. - resourceGroupName required
string
: The resource group name. - jobCollectionName required
string
: The job collection name. - api-version required
string
: The API version.
- subscriptionId required
Output
Output schema unknown
JobCollections_Get
Gets a job collection.
azure_scheduler.JobCollections_Get({
"subscriptionId": "",
"resourceGroupName": "",
"jobCollectionName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription id. - resourceGroupName required
string
: The resource group name. - jobCollectionName required
string
: The job collection name. - api-version required
string
: The API version.
- subscriptionId required
Output
- output JobCollectionDefinition
JobCollections_Patch
Patches an existing job collection.
azure_scheduler.JobCollections_Patch({
"subscriptionId": "",
"resourceGroupName": "",
"jobCollectionName": "",
"api-version": "",
"jobCollection": null
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription id. - resourceGroupName required
string
: The resource group name. - jobCollectionName required
string
: The job collection name. - api-version required
string
: The API version. - jobCollection required JobCollectionDefinition
- subscriptionId required
Output
- output JobCollectionDefinition
JobCollections_CreateOrUpdate
Provisions a new job collection or updates an existing job collection.
azure_scheduler.JobCollections_CreateOrUpdate({
"subscriptionId": "",
"resourceGroupName": "",
"jobCollectionName": "",
"api-version": "",
"jobCollection": null
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription id. - resourceGroupName required
string
: The resource group name. - jobCollectionName required
string
: The job collection name. - api-version required
string
: The API version. - jobCollection required JobCollectionDefinition
- subscriptionId required
Output
- output JobCollectionDefinition
JobCollections_Disable
Disables all of the jobs in the job collection.
azure_scheduler.JobCollections_Disable({
"subscriptionId": "",
"resourceGroupName": "",
"jobCollectionName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription id. - resourceGroupName required
string
: The resource group name. - jobCollectionName required
string
: The job collection name. - api-version required
string
: The API version.
- subscriptionId required
Output
Output schema unknown
JobCollections_Enable
Enables all of the jobs in the job collection.
azure_scheduler.JobCollections_Enable({
"subscriptionId": "",
"resourceGroupName": "",
"jobCollectionName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription id. - resourceGroupName required
string
: The resource group name. - jobCollectionName required
string
: The job collection name. - api-version required
string
: The API version.
- subscriptionId required
Output
Output schema unknown
Jobs_List
Lists all jobs under the specified job collection.
azure_scheduler.Jobs_List({
"subscriptionId": "",
"resourceGroupName": "",
"jobCollectionName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription id. - resourceGroupName required
string
: The resource group name. - jobCollectionName required
string
: The job collection name. - api-version required
string
: The API version. - $top
integer
: The number of jobs to request, in the of range of 1..100. - $skip
integer
: The (0-based) index of the job history list from which to begin requesting entries. - $filter
string
: The filter to apply on the job state.
- subscriptionId required
Output
- output JobListResult
Jobs_Delete
Deletes a job.
azure_scheduler.Jobs_Delete({
"subscriptionId": "",
"resourceGroupName": "",
"jobCollectionName": "",
"jobName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription id. - resourceGroupName required
string
: The resource group name. - jobCollectionName required
string
: The job collection name. - jobName required
string
: The job name. - api-version required
string
: The API version.
- subscriptionId required
Output
Output schema unknown
Jobs_Get
Gets a job.
azure_scheduler.Jobs_Get({
"subscriptionId": "",
"resourceGroupName": "",
"jobCollectionName": "",
"jobName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription id. - resourceGroupName required
string
: The resource group name. - jobCollectionName required
string
: The job collection name. - jobName required
string
: The job name. - api-version required
string
: The API version.
- subscriptionId required
Output
- output JobDefinition
Jobs_Patch
Patches an existing job.
azure_scheduler.Jobs_Patch({
"subscriptionId": "",
"resourceGroupName": "",
"jobCollectionName": "",
"jobName": "",
"api-version": "",
"job": null
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription id. - resourceGroupName required
string
: The resource group name. - jobCollectionName required
string
: The job collection name. - jobName required
string
: The job name. - api-version required
string
: The API version. - job required JobDefinition
- subscriptionId required
Output
- output JobDefinition
Jobs_CreateOrUpdate
Provisions a new job or updates an existing job.
azure_scheduler.Jobs_CreateOrUpdate({
"subscriptionId": "",
"resourceGroupName": "",
"jobCollectionName": "",
"jobName": "",
"api-version": "",
"job": null
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription id. - resourceGroupName required
string
: The resource group name. - jobCollectionName required
string
: The job collection name. - jobName required
string
: The job name. - api-version required
string
: The API version. - job required JobDefinition
- subscriptionId required
Output
- output JobDefinition
Jobs_ListJobHistory
Lists job history.
azure_scheduler.Jobs_ListJobHistory({
"subscriptionId": "",
"resourceGroupName": "",
"jobCollectionName": "",
"jobName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription id. - resourceGroupName required
string
: The resource group name. - jobCollectionName required
string
: The job collection name. - jobName required
string
: The job name. - api-version required
string
: The API version. - $top
integer
: the number of job history to request, in the of range of 1..100. - $skip
integer
: The (0-based) index of the job history list from which to begin requesting entries. - $filter
string
: The filter to apply on the job state.
- subscriptionId required
Output
- output JobHistoryListResult
Jobs_Run
Runs a job.
azure_scheduler.Jobs_Run({
"subscriptionId": "",
"resourceGroupName": "",
"jobCollectionName": "",
"jobName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription id. - resourceGroupName required
string
: The resource group name. - jobCollectionName required
string
: The job collection name. - jobName required
string
: The job name. - api-version required
string
: The API version.
- subscriptionId required
Output
Output schema unknown
Definitions
BasicAuthentication
- BasicAuthentication
object
- password
string
: Gets or sets the password, return value will always be empty. - username
string
: Gets or sets the username. - type required
string
(values: NotSpecified, ClientCertificate, ActiveDirectoryOAuth, Basic): Gets or sets the HTTP authentication type.
- password
ClientCertAuthentication
- ClientCertAuthentication
object
- certificateExpirationDate
string
: Gets or sets the certificate expiration date. - certificateSubjectName
string
: Gets or sets the certificate subject name. - certificateThumbprint
string
: Gets or sets the certificate thumbprint. - password
string
: Gets or sets the certificate password, return value will always be empty. - pfx
string
: Gets or sets the pfx certificate. Accepts certification in base64 encoding, return value will always be empty. - type required
string
(values: NotSpecified, ClientCertificate, ActiveDirectoryOAuth, Basic): Gets or sets the HTTP authentication type.
- certificateExpirationDate
HttpAuthentication
- HttpAuthentication
object
- type required
string
(values: NotSpecified, ClientCertificate, ActiveDirectoryOAuth, Basic): Gets or sets the HTTP authentication type.
- type required
HttpRequest
- HttpRequest
object
- authentication HttpAuthentication
- body
string
: Gets or sets the request body. - headers
object
: Gets or sets the headers. - method
string
: Gets or sets the method of the request. - uri
string
: Gets or sets the URI of the request.
JobAction
- JobAction
object
- errorAction JobErrorAction
- queueMessage StorageQueueMessage
- request HttpRequest
- retryPolicy RetryPolicy
- serviceBusQueueMessage ServiceBusQueueMessage
- serviceBusTopicMessage ServiceBusTopicMessage
- type
string
(values: Http, Https, StorageQueue, ServiceBusQueue, ServiceBusTopic): Gets or sets the job action type.
JobCollectionDefinition
- JobCollectionDefinition
object
- id
string
: Gets the job collection resource identifier. - location
string
: Gets or sets the storage account location. - name
string
: Gets or sets the job collection resource name. - properties JobCollectionProperties
- tags
object
: Gets or sets the tags. - type
string
: Gets the job collection resource type.
- id
JobCollectionListResult
- JobCollectionListResult
object
- nextLink
string
: Gets or sets the URL to get the next set of job collections. - value
array
: Gets the job collections.- items JobCollectionDefinition
- nextLink
JobCollectionProperties
- JobCollectionProperties
object
- quota JobCollectionQuota
- sku Sku
- state
string
(values: Enabled, Disabled, Suspended, Deleted): Gets or sets the state.
JobCollectionQuota
- JobCollectionQuota
object
- maxJobCount
integer
: Gets or set the maximum job count. - maxJobOccurrence
integer
: Gets or sets the maximum job occurrence. - maxRecurrence JobMaxRecurrence
- maxJobCount
JobDefinition
- JobDefinition
object
- id
string
: Gets the job resource identifier. - name
string
: Gets the job resource name. - properties JobProperties
- type
string
: Gets the job resource type.
- id
JobErrorAction
- JobErrorAction
object
- queueMessage StorageQueueMessage
- request HttpRequest
- retryPolicy RetryPolicy
- serviceBusQueueMessage ServiceBusQueueMessage
- serviceBusTopicMessage ServiceBusTopicMessage
- type
string
(values: Http, Https, StorageQueue, ServiceBusQueue, ServiceBusTopic): Gets or sets the job error action type.
JobExecutionStatus
- JobExecutionStatus
string
(values: Completed, Failed, Postponed): Gets the job execution status.
JobHistoryDefinition
- JobHistoryDefinition
object
- id
string
: Gets the job history identifier. - name
string
: Gets the job history name. - properties JobHistoryDefinitionProperties
- type
string
: Gets the job history resource type.
- id
JobHistoryDefinitionProperties
- JobHistoryDefinitionProperties
object
- actionName
string
(values: MainAction, ErrorAction): Gets the job history action name. - endTime
string
: Gets the end time for this job. - expectedExecutionTime
string
: Gets the expected execution time for this job. - message
string
: Gets the message for the job history. - repeatCount
integer
: Gets the repeat count for the job. - retryCount
integer
: Gets the retry count for job. - startTime
string
: Gets the start time for this job. - status JobExecutionStatus
- actionName
JobHistoryFilter
- JobHistoryFilter
object
- status JobExecutionStatus
JobHistoryListResult
- JobHistoryListResult
object
- nextLink
string
: Gets or sets the URL to get the next set of job histories. - value
array
: Gets or sets the job histories under job.- items JobHistoryDefinition
- nextLink
JobListResult
- JobListResult
object
- nextLink
string
: Gets or sets the URL to get the next set of jobs. - value
array
: Gets or sets all jobs under job collection.- items JobDefinition
- nextLink
JobMaxRecurrence
- JobMaxRecurrence
object
- frequency
string
(values: Minute, Hour, Day, Week, Month): Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). - interval
integer
: Gets or sets the interval between retries.
- frequency
JobProperties
- JobProperties
object
- action JobAction
- recurrence JobRecurrence
- startTime
string
: Gets or sets the job start time. - state JobState
- status JobStatus
JobRecurrence
- JobRecurrence
object
- count
integer
: Gets or sets the maximum number of times that the job should run. - endTime
string
: Gets or sets the time at which the job will complete. - frequency
string
(values: Minute, Hour, Day, Week, Month): Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). - interval
integer
: Gets or sets the interval between retries. - schedule JobRecurrenceSchedule
- count
JobRecurrenceSchedule
- JobRecurrenceSchedule
object
- hours
array
: Gets or sets the hours of the day that the job should execute at.- items
integer
- items
- minutes
array
: Gets or sets the minutes of the hour that the job should execute at.- items
integer
- items
- monthDays
array
: Gets or sets the days of the month that the job should execute on. Must be between 1 and 31.- items
integer
- items
- monthlyOccurrences
array
: Gets or sets the occurrences of days within a month. - weekDays
array
: Gets or sets the days of the week that the job should execute on.- items
string
(values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday)
- items
- hours
JobRecurrenceScheduleMonthlyOccurrence
- JobRecurrenceScheduleMonthlyOccurrence
object
- Occurrence
integer
: Gets or sets the occurrence. Must be between -5 and 5. - day
string
(values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday): Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
- Occurrence
JobState
- JobState
string
(values: Enabled, Disabled, Faulted, Completed): Gets or set the job state.
JobStateFilter
- JobStateFilter
object
- state JobState
JobStatus
- JobStatus
object
- executionCount
integer
: Gets the number of times this job has executed. - failureCount
integer
: Gets the number of times this job has failed. - faultedCount
integer
: Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states). - lastExecutionTime
string
: Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet. - nextExecutionTime
string
: Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed.
- executionCount
OAuthAuthentication
- OAuthAuthentication
object
- audience
string
: Gets or sets the audience. - clientId
string
: Gets or sets the client identifier. - secret
string
: Gets or sets the secret, return value will always be empty. - tenant
string
: Gets or sets the tenant. - type required
string
(values: NotSpecified, ClientCertificate, ActiveDirectoryOAuth, Basic): Gets or sets the HTTP authentication type.
- audience
RecurrenceFrequency
- RecurrenceFrequency
string
(values: Minute, Hour, Day, Week, Month): Gets or sets the frequency of recurrence (minute, hour, day, week, month).
RetryPolicy
- RetryPolicy
object
- retryCount
integer
: Gets or sets the number of times a retry should be attempted. - retryInterval
string
: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. - retryType
string
(values: None, Fixed): Gets or sets the retry strategy to be used.
- retryCount
ServiceBusAuthentication
- ServiceBusAuthentication
object
- sasKey
string
: Gets or sets the SAS key. - sasKeyName
string
: Gets or sets the SAS key name. - type
string
(values: NotSpecified, SharedAccessKey): Gets or sets the authentication type.
- sasKey
ServiceBusBrokeredMessageProperties
- ServiceBusBrokeredMessageProperties
object
- contentType
string
: Gets or sets the content type. - correlationId
string
: Gets or sets the correlation ID. - forcePersistence
boolean
: Gets or sets the force persistence. - label
string
: Gets or sets the label. - messageId
string
: Gets or sets the message ID. - partitionKey
string
: Gets or sets the partition key. - replyTo
string
: Gets or sets the reply to. - replyToSessionId
string
: Gets or sets the reply to session ID. - scheduledEnqueueTimeUtc
string
: Gets or sets the scheduled enqueue time UTC. - sessionId
string
: Gets or sets the session ID. - timeToLive
string
: Gets or sets the time to live. - to
string
: Gets or sets the to. - viaPartitionKey
string
: Gets or sets the via partition key.
- contentType
ServiceBusMessage
- ServiceBusMessage
object
- authentication ServiceBusAuthentication
- brokeredMessageProperties ServiceBusBrokeredMessageProperties
- customMessageProperties
object
: Gets or sets the custom message properties. - message
string
: Gets or sets the message. - namespace
string
: Gets or sets the namespace. - transportType
string
(values: NotSpecified, NetMessaging, AMQP): Gets or sets the transport type.
ServiceBusQueueMessage
- ServiceBusQueueMessage
object
- queueName
string
: Gets or sets the queue name. - authentication ServiceBusAuthentication
- brokeredMessageProperties ServiceBusBrokeredMessageProperties
- customMessageProperties
object
: Gets or sets the custom message properties. - message
string
: Gets or sets the message. - namespace
string
: Gets or sets the namespace. - transportType
string
(values: NotSpecified, NetMessaging, AMQP): Gets or sets the transport type.
- queueName
ServiceBusTopicMessage
- ServiceBusTopicMessage
object
- topicPath
string
: Gets or sets the topic path. - authentication ServiceBusAuthentication
- brokeredMessageProperties ServiceBusBrokeredMessageProperties
- customMessageProperties
object
: Gets or sets the custom message properties. - message
string
: Gets or sets the message. - namespace
string
: Gets or sets the namespace. - transportType
string
(values: NotSpecified, NetMessaging, AMQP): Gets or sets the transport type.
- topicPath
Sku
- Sku
object
- name
string
(values: Standard, Free, P10Premium, P20Premium): Gets or set the SKU.
- name
StorageQueueMessage
- StorageQueueMessage
object
- message
string
: Gets or sets the message. - queueName
string
: Gets or sets the queue name. - sasToken
string
: Gets or sets the SAS key. - storageAccount
string
: Gets or sets the storage account name.
- message