Share via


MultiInstanceSettings Class

Definition

Settings which specify how to run a multi-instance Task.

public class MultiInstanceSettings
type MultiInstanceSettings = class
Public Class MultiInstanceSettings
Inheritance
MultiInstanceSettings

Remarks

Multi-instance Tasks are commonly used to support MPI Tasks. In the MPI case, if any of the subtasks fail (for example due to exiting with a non-zero exit code) the entire multi-instance Task fails. The multi-instance Task is then terminated and retried, up to its retry limit.

Constructors

MultiInstanceSettings()

Initializes a new instance of the MultiInstanceSettings class.

MultiInstanceSettings(String, Nullable<Int32>, IList<ResourceFile>)

Initializes a new instance of the MultiInstanceSettings class.

Properties

CommonResourceFiles

Gets or sets a list of files that the Batch service will download before running the coordination command line.

CoordinationCommandLine

Gets or sets the command line to run on all the Compute Nodes to enable them to coordinate when the primary runs the main Task command.

NumberOfInstances

Gets or sets the number of Compute Nodes required by the Task.

Applies to