Share via

TaskContainerSettings Class

  • Reference

The container settings for a task.

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

Inheritance
azure.mgmt.batch._serialization.Model
TaskContainerSettings

Constructor

TaskContainerSettings(*, image_name: str, container_run_options: str | None = None, registry: _models.ContainerRegistry | None = None, working_directory: str | _models.ContainerWorkingDirectory | None = None, container_host_batch_bind_mounts: List[_models.ContainerHostBatchBindMountEntry] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
container_run_options
str

These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service.
image_name
str

This is the full image reference, as would be specified to "docker pull". If no tag is provided as part of the image name, the tag ":latest" is used as a default. Required.
registry
ContainerRegistry

This setting can be omitted if was already provided at pool creation.
working_directory
str or ContainerWorkingDirectory

A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'. Known values are: "TaskWorkingDirectory" and "ContainerImageDefault".
container_host_batch_bind_mounts
list[ContainerHostBatchBindMountEntry]

If this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty.

Variables

Name Description
container_run_options
str

These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service.
image_name
str

This is the full image reference, as would be specified to "docker pull". If no tag is provided as part of the image name, the tag ":latest" is used as a default. Required.
registry
ContainerRegistry

This setting can be omitted if was already provided at pool creation.
working_directory
str or ContainerWorkingDirectory

A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'. Known values are: "TaskWorkingDirectory" and "ContainerImageDefault".
container_host_batch_bind_mounts
list[ContainerHostBatchBindMountEntry]

If this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty.