Share via


BatchTaskContainerSettings Class

Definition

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

BatchTaskContainerSettings(String)

Initializes a new instance of BatchTaskContainerSettings.

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

Explicit Interface Implementations

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