JobAddParameter Class

An Azure Batch Job to add.

All required parameters must be populated in order to send to Azure.

Inheritance
JobAddParameter

Constructor

JobAddParameter(*, id: str, pool_info, display_name: Optional[str] = None, priority: Optional[int] = None, max_parallel_tasks: int = -1, constraints=None, job_manager_task=None, job_preparation_task=None, job_release_task=None, common_environment_settings=None, on_all_tasks_complete=None, on_task_failure=None, metadata=None, uses_task_dependencies: Optional[bool] = None, network_configuration=None, **kwargs)

Parameters

id
str
Required

Required. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case).

display_name
str
Required

The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.

priority
int
Required

The priority of the Job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0.

max_parallel_tasks
int
Required

The maximum number of tasks that can be executed in parallel for the job. The value of maxParallelTasks must be -1 or greater than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API. Default value: -1 .

constraints
JobConstraints
Required

The execution constraints for the Job.

job_manager_task
JobManagerTask
Required

Details of a Job Manager Task to be launched when the Job is started. If the Job does not specify a Job Manager Task, the user must explicitly add Tasks to the Job. If the Job does specify a Job Manager Task, the Batch service creates the Job Manager Task when the Job is created, and will try to schedule the Job Manager Task before scheduling other Tasks in the Job. The Job Manager Task's typical purpose is to control and/or monitor Job execution, for example by deciding what additional Tasks to run, determining when the work is complete, etc. (However, a Job Manager Task is not restricted to these activities - it is a fully-fledged Task in the system and perform whatever actions are required for the Job.) For example, a Job Manager Task might download a file specified as a parameter, analyze the contents of that file and submit additional Tasks based on those contents.

job_preparation_task
JobPreparationTask
Required

The Job Preparation Task. If a Job has a Job Preparation Task, the Batch service will run the Job Preparation Task on a Node before starting any Tasks of that Job on that Compute Node.

job_release_task
JobReleaseTask
Required

The Job Release Task. A Job Release Task cannot be specified without also specifying a Job Preparation Task for the Job. The Batch service runs the Job Release Task on the Nodes that have run the Job Preparation Task. The primary purpose of the Job Release Task is to undo changes to Compute Nodes made by the Job Preparation Task. Example activities include deleting local files, or shutting down services that were started as part of Job preparation.

common_environment_settings
list[EnvironmentSetting]
Required

Individual Tasks can override an environment setting specified here by specifying the same setting name with a different value.

pool_info
PoolInformation
Required

Required. The Pool on which the Batch service runs the Job's Tasks.

on_all_tasks_complete
str or OnAllTasksComplete
Required

The action the Batch service should take when all Tasks in the Job are in the completed state. Note that if a Job contains no Tasks, then all Tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic Job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the Job properties to set onAllTasksComplete to terminatejob once you have finished adding Tasks. The default is noaction. Possible values include: 'noAction', 'terminateJob'

on_task_failure
str or OnTaskFailure
Required

The action the Batch service should take when any Task in the Job fails. A Task is considered to 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. The default is noaction. Possible values include: 'noAction', 'performExitOptionsJobAction'

metadata
list[MetadataItem]
Required

The Batch service does not assign any meaning to metadata; it is solely for the use of user code.

uses_task_dependencies
bool
Required

Whether Tasks in the Job can define dependencies on each other. The default is false.

network_configuration
JobNetworkConfiguration
Required

The network configuration for the Job.