TaskContainerSettings interface

Package:

@azure/batch

An interface representing TaskContainerSettings.

Properties

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 include: 'taskWorkingDirectory', 'containerImageDefault'

Property Details

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?: ContainerRegistry

Property Value

ContainerRegistry

workingDirectory

The location of the container Task working directory. The default is 'taskWorkingDirectory'. Possible values include: 'taskWorkingDirectory', 'containerImageDefault'

workingDirectory?: ContainerWorkingDirectory

Property Value

ContainerWorkingDirectory