Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

BatchTaskContainerSettings Class

Definition

Namespace:
Azure.Compute.Batch
Assembly:
Azure.Compute.Batch.dll
Package:
Azure.Compute.Batch v1.0.0
Package:
Azure.Compute.Batch v1.0.0-beta.5
Source:
BatchTaskContainerSettings.cs
Source:
BatchTaskContainerSettings.cs

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 class BatchTaskContainerSettings : System.ClientModel.Primitives.IJsonModel<Azure.Compute.Batch.BatchTaskContainerSettings>, System.ClientModel.Primitives.IPersistableModel<Azure.Compute.Batch.BatchTaskContainerSettings>
type BatchTaskContainerSettings = class
 interface IJsonModel<BatchTaskContainerSettings>
 interface IPersistableModel<BatchTaskContainerSettings>
Public Class BatchTaskContainerSettings
Implements IJsonModel(Of BatchTaskContainerSettings), IPersistableModel(Of BatchTaskContainerSettings)
Inheritance
BatchTaskContainerSettings
Implements

Constructors

Name Description
BatchTaskContainerSettings(String)

Initializes a new instance of BatchTaskContainerSettings.

Properties

Name Description
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'.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<BatchTaskContainerSettings>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<BatchTaskContainerSettings>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<BatchTaskContainerSettings>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<BatchTaskContainerSettings>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<BatchTaskContainerSettings>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to


Feedback

Was this page helpful?