BatchTaskContainerSettings interface

Package:

@azure-rest/batch

The container settings for a Task.

Properties

containerHostBatchBindMounts	The paths you want to mounted to container task. 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.
containerRunOptions	Additional options to the container create command. These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service.
imageName	The Image to use to create the container in which the Task will run. 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.
registry	The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation.
workingDirectory	The location of the container Task working directory. The default is 'taskWorkingDirectory'. Possible values: "taskWorkingDirectory", "containerImageDefault"

Property Details

containerHostBatchBindMounts

The paths you want to mounted to container task. 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.

containerHostBatchBindMounts?: ContainerHostBatchBindMountEntry[]

Property Value

ContainerHostBatchBindMountEntry[]

containerRunOptions

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

containerRunOptions?: string

Property Value

string

imageName

The Image to use to create the container in which the Task will run. 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.

imageName: string

Property Value

string

registry

The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation.

registry?: ContainerRegistryReference

Property Value

ContainerRegistryReference

workingDirectory

The location of the container Task working directory. The default is 'taskWorkingDirectory'.

Possible values: "taskWorkingDirectory", "containerImageDefault"

workingDirectory?: string

Property Value

string