ComputeBatchModelFactory.BatchTaskContainerSettings Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The container settings for a Task.
public static Azure.Compute.Batch.BatchTaskContainerSettings BatchTaskContainerSettings(string containerRunOptions = default, string imageName = default, Azure.Compute.Batch.ContainerRegistryReference registry = default, Azure.Compute.Batch.ContainerWorkingDirectory? workingDirectory = default, System.Collections.Generic.IEnumerable<Azure.Compute.Batch.ContainerHostBatchBindMountEntry> containerHostBatchBindMounts = default);static member BatchTaskContainerSettings : string * string * Azure.Compute.Batch.ContainerRegistryReference * Nullable<Azure.Compute.Batch.ContainerWorkingDirectory> * seq<Azure.Compute.Batch.ContainerHostBatchBindMountEntry> -> Azure.Compute.Batch.BatchTaskContainerSettingsPublic Shared Function BatchTaskContainerSettings (Optional containerRunOptions As String = Nothing, Optional imageName As String = Nothing, Optional registry As ContainerRegistryReference = Nothing, Optional workingDirectory As Nullable(Of ContainerWorkingDirectory) = Nothing, Optional containerHostBatchBindMounts As IEnumerable(Of ContainerHostBatchBindMountEntry) = Nothing) As BatchTaskContainerSettingsParameters
- containerRunOptions
- String
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
- String
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
- ContainerRegistryReference
The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation.
- workingDirectory
- Nullable<ContainerWorkingDirectory>
The location of the container Task working directory. The default is 'taskWorkingDirectory'.
- containerHostBatchBindMounts
- IEnumerable<ContainerHostBatchBindMountEntry>
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.
Returns
A new BatchTaskContainerSettings instance for mocking.
