BatchAccountPoolStartTask Class

  • Reference

Definition

Namespace:
Azure.ResourceManager.Batch.Models
Assembly:
Azure.ResourceManager.Batch.dll
Package:
Azure.ResourceManager.Batch v1.5.0
Package:
Azure.ResourceManager.Batch v1.3.0-beta.1
Source:
BatchAccountPoolStartTask.cs
Source:
BatchAccountPoolStartTask.cs

In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task.

public class BatchAccountPoolStartTask : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Batch.Models.BatchAccountPoolStartTask>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Batch.Models.BatchAccountPoolStartTask>
public class BatchAccountPoolStartTask
type BatchAccountPoolStartTask = class
    interface IJsonModel<BatchAccountPoolStartTask>
    interface IPersistableModel<BatchAccountPoolStartTask>
type BatchAccountPoolStartTask = class
Public Class BatchAccountPoolStartTask
Implements IJsonModel(Of BatchAccountPoolStartTask), IPersistableModel(Of BatchAccountPoolStartTask)
Public Class BatchAccountPoolStartTask
Inheritance
Object
BatchAccountPoolStartTask
Implements
IJsonModel<BatchAccountPoolStartTask> IPersistableModel<BatchAccountPoolStartTask> IPersistableModel<T>

Constructors

BatchAccountPoolStartTask()

Initializes a new instance of BatchAccountPoolStartTask.

Properties

CommandLine

The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. Required if any other properties of the startTask are specified.
ContainerSettings

When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container.
EnvironmentSettings

A list of environment variable settings for the start task.
MaxTaskRetryCount

The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit. Default is 0.
ResourceFiles

A list of files that the Batch service will download to the compute node before running the command line.
UserIdentity

If omitted, the task runs as a non-administrative user unique to the task.
WaitForSuccess

If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true.

Explicit Interface Implementations

IJsonModel<BatchAccountPoolStartTask>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<BatchAccountPoolStartTask>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IPersistableModel<BatchAccountPoolStartTask>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<BatchAccountPoolStartTask>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<BatchAccountPoolStartTask>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to