CloudJobSchedule Class

Definition

Namespace:

Microsoft.Azure.Batch

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.3.1

Source:

CloudJobSchedule.cs

A job schedule that allows recurring jobs by specifying when to run jobs and a specification used to create each job.

public class CloudJobSchedule : Microsoft.Azure.Batch.IInheritedBehaviors, Microsoft.Azure.Batch.IRefreshable

type CloudJobSchedule = class
    interface IRefreshable
    interface IInheritedBehaviors

Public Class CloudJobSchedule
Implements IInheritedBehaviors, IRefreshable

Inheritance

Object

CloudJobSchedule

Implements

IInheritedBehaviors IRefreshable

Constructors

CloudJobSchedule()

Default constructor to support mocking the CloudJobSchedule class.

Properties

CreationTime	Gets the creation time of the job schedule.
CustomBehaviors	Gets or sets a list of behaviors that modify or customize requests to the Batch service made via this CloudJobSchedule.
DisplayName	Gets or sets the display name of the job schedule.
ETag	Gets the ETag of the job schedule.
ExecutionInformation	Gets the execution information for the job schedule.
Id	Gets or sets the id of the job schedule.
JobSpecification	Gets or sets a JobSpecification containing details of the jobs to be created according to the Schedule.
LastModified	Gets the last modified time of the job schedule.
Metadata	Gets or sets a list of name-value pairs associated with the schedule as metadata.
PreviousState	Gets the previous state of the job schedule.
PreviousStateTransitionTime	Gets the time at which the job schedule entered its previous state.
Schedule	Gets or sets the schedule that determines when jobs will be created.
State	Gets the current state of the job schedule.
StateTransitionTime	Gets the time at which the CloudJobSchedule entered its current state.
Statistics	Gets a JobScheduleStatistics containing resource usage statistics for the entire lifetime of the job schedule.
Url	Gets the URL of the job schedule.

Methods

Commit(IEnumerable<BatchClientBehavior>)	Commits this CloudJobSchedule to the Azure Batch service.
CommitAsync(IEnumerable<BatchClientBehavior>, CancellationToken)	Commits this CloudJobSchedule to the Azure Batch service.
CommitChanges(IEnumerable<BatchClientBehavior>)	Commits all pending changes to this CloudJobSchedule to the Azure Batch service.
CommitChangesAsync(IEnumerable<BatchClientBehavior>, CancellationToken)	Commits all pending changes to this CloudJobSchedule to the Azure Batch service.
Delete(IEnumerable<BatchClientBehavior>)	Deletes this CloudJobSchedule.
DeleteAsync(IEnumerable<BatchClientBehavior>, CancellationToken)	Deletes this CloudJobSchedule.
Disable(IEnumerable<BatchClientBehavior>)	Disables this CloudJobSchedule. Disabled schedules do not create new jobs, but may be re-enabled later.
DisableAsync(IEnumerable<BatchClientBehavior>, CancellationToken)	Disables this CloudJobSchedule. Disabled schedules do not create new jobs, but may be re-enabled later.
Enable(IEnumerable<BatchClientBehavior>)	Enables this CloudJobSchedule, allowing jobs to be created according to the Schedule.
EnableAsync(IEnumerable<BatchClientBehavior>, CancellationToken)	Enables this CloudJobSchedule, allowing jobs to be created according to the Schedule.
ListJobs(DetailLevel, IEnumerable<BatchClientBehavior>)	Enumerates the jobs created under this CloudJobSchedule.
Refresh(DetailLevel, IEnumerable<BatchClientBehavior>)	Refreshes the current CloudJobSchedule.
RefreshAsync(DetailLevel, IEnumerable<BatchClientBehavior>, CancellationToken)	Refreshes the current CloudJobSchedule.
Terminate(IEnumerable<BatchClientBehavior>)	Terminates this CloudJobSchedule. Terminated schedules remain in the system but do not create new jobs.
TerminateAsync(IEnumerable<BatchClientBehavior>, CancellationToken)	Terminates this CloudJobSchedule. Terminated schedules remain in the system but do not create new jobs.