Share via


MultiInstanceSettings Class

Definition

Settings which specify how to run a multi-instance task. 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. For more information see https://azure.microsoft.com/documentation/articles/batch-mpi/.

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

Constructors

MultiInstanceSettings()

Default constructor to support mocking the MultiInstanceSettings class.

MultiInstanceSettings(String, Nullable<Int32>)

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 to run on the compute node instances for coordinating among the subtasks.

NumberOfInstances

Gets or sets the number of compute nodes required by the multi-instance task.

Applies to