ArmBatchModelFactory.BatchTaskContainerSettings Method

Definition

The container settings for a task.

public static Azure.ResourceManager.Batch.Models.BatchTaskContainerSettings BatchTaskContainerSettings(string containerRunOptions = default, string imageName = default, Azure.ResourceManager.Batch.Models.BatchVmContainerRegistry registry = default, Azure.ResourceManager.Batch.Models.BatchContainerWorkingDirectory? workingDirectory = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Batch.Models.ContainerHostBatchBindMountEntry> containerHostBatchBindMounts = default);
static member BatchTaskContainerSettings : string * string * Azure.ResourceManager.Batch.Models.BatchVmContainerRegistry * Nullable<Azure.ResourceManager.Batch.Models.BatchContainerWorkingDirectory> * seq<Azure.ResourceManager.Batch.Models.ContainerHostBatchBindMountEntry> -> Azure.ResourceManager.Batch.Models.BatchTaskContainerSettings
Public Shared Function BatchTaskContainerSettings (Optional containerRunOptions As String = Nothing, Optional imageName As String = Nothing, Optional registry As BatchVmContainerRegistry = Nothing, Optional workingDirectory As Nullable(Of BatchContainerWorkingDirectory) = Nothing, Optional containerHostBatchBindMounts As IEnumerable(Of ContainerHostBatchBindMountEntry) = Nothing) As BatchTaskContainerSettings

Parameters

containerRunOptions
String

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

imageName
String

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
BatchVmContainerRegistry

This setting can be omitted if was already provided at pool creation.

workingDirectory
Nullable<BatchContainerWorkingDirectory>

A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'.

containerHostBatchBindMounts
IEnumerable<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.

Returns

A new BatchTaskContainerSettings instance for mocking.

Applies to