Share via


JobSpecification Class

Definition

Specifies details of the Jobs to be created on a schedule.

public class JobSpecification
type JobSpecification = class
Public Class JobSpecification
Inheritance
JobSpecification

Constructors

JobSpecification()

Initializes a new instance of the JobSpecification class.

JobSpecification(PoolInformation, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, String, Nullable<Boolean>, Nullable<OnAllTasksComplete>, Nullable<OnTaskFailure>, JobNetworkConfiguration, JobConstraints, JobManagerTask, JobPreparationTask, JobReleaseTask, IList<EnvironmentSetting>, IList<MetadataItem>)

Initializes a new instance of the JobSpecification class.

Properties

AllowTaskPreemption

Gets or sets whether Tasks in this job can be preempted by other high priority jobs

CommonEnvironmentSettings

Gets or sets a list of common environment variable settings. These environment variables are set for all Tasks in Jobs created under this schedule (including the Job Manager, Job Preparation and Job Release Tasks).

Constraints

Gets or sets the execution constraints for Jobs created under this schedule.

DisplayName

Gets or sets the display name for Jobs created under this schedule.

JobManagerTask

Gets or sets the details of a Job Manager Task to be launched when a Job is started under this schedule.

JobPreparationTask

Gets or sets the Job Preparation Task for Jobs created under this schedule.

JobReleaseTask

Gets or sets the Job Release Task for Jobs created under this schedule.

MaxParallelTasks

Gets or sets the maximum number of tasks that can be executed in parallel for the job.

Metadata

Gets or sets a list of name-value pairs associated with each Job created under this schedule as metadata.

NetworkConfiguration

Gets or sets the network configuration for the Job.

OnAllTasksComplete

Gets or sets the action the Batch service should take when all Tasks in a Job created under this schedule are in the completed state.

OnTaskFailure

Gets or sets the action the Batch service should take when any Task fails in a Job created under this schedule. A Task is considered to have failed if it have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error.

PoolInfo

Gets or sets the Pool on which the Batch service runs the Tasks of Jobs created under this schedule.

Priority

Gets or sets the priority of Jobs created under this schedule.

UsesTaskDependencies

Gets or sets whether Tasks in the Job can define dependencies on each other. The default is false.

Applies to