Share via


StartTask Class

A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged.

Constructor

StartTask(*args: Any, **kwargs: Any)

Variables

Name Description
command_line
str

The command line of the start task.

resource_files

A list of files that the Batch service will download to the compute node before running the command line.

environment_settings

A list of environment variable settings for the start task.

user_identity

The user identity under which the start task runs.

max_task_retry_count
int

The maximum number of times the task may be retried.

wait_for_success

Whether the Batch service should wait for the start task to complete successfully (that is, to exit with exit code 0) before scheduling any tasks on the compute node.

container_settings

The settings for the container under which the start task runs.

Attributes

command_line

The command line of the start task.

command_line: str | None

container_settings

The settings for the container under which the start task runs.

container_settings: _models.TaskContainerSettings | None

environment_settings

A list of environment variable settings for the start task.

environment_settings: list['_models.EnvironmentSetting'] | None

max_task_retry_count

The maximum number of times the task may be retried.

max_task_retry_count: int | None

resource_files

A list of files that the Batch service will download to the compute node before running the command line.

resource_files: list['_models.ResourceFile'] | None

user_identity

The user identity under which the start task runs.

user_identity: _models.UserIdentity | None

wait_for_success

Whether the Batch service should wait for the start task to complete successfully (that is, to exit with exit code 0) before scheduling any tasks on the compute node.

wait_for_success: bool | None