StartTask.WaitForSuccess Property

Definition

Namespace:

Microsoft.Azure.Batch.Protocol.Models

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.3.1

Source:

StartTask.cs

Gets or sets whether the Batch service should wait for the StartTask to complete successfully (that is, to exit with exit code 0) before scheduling any Tasks on the Compute Node.

[Newtonsoft.Json.JsonProperty(PropertyName="waitForSuccess")]
public bool? WaitForSuccess { get; set; }

[<Newtonsoft.Json.JsonProperty(PropertyName="waitForSuccess")>]
member this.WaitForSuccess : Nullable<bool> with get, set

Public Property WaitForSuccess As Nullable(Of Boolean)

Property Value

Nullable<Boolean>

Attributes

Newtonsoft.Json.JsonPropertyAttribute

Remarks

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