Schedule.RecurrenceInterval Property

Definition

Namespace:

Microsoft.Azure.Batch.Protocol.Models

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.3.1

Source:

Schedule.cs

Gets or sets the time interval between the start times of two successive Jobs under the Job Schedule. A Job Schedule can have at most one active Job under it at any given time.

[Newtonsoft.Json.JsonProperty(PropertyName="recurrenceInterval")]
public TimeSpan? RecurrenceInterval { get; set; }

[<Newtonsoft.Json.JsonProperty(PropertyName="recurrenceInterval")>]
member this.RecurrenceInterval : Nullable<TimeSpan> with get, set

Public Property RecurrenceInterval As Nullable(Of TimeSpan)

Property Value

Nullable<TimeSpan>

Attributes

Newtonsoft.Json.JsonPropertyAttribute

Remarks

Because a Job Schedule can have at most one active Job under it at any given time, if it is time to create a new Job under a Job Schedule, but the previous Job is still running, the Batch service will not create the new Job until the previous Job finishes. If the previous Job does not finish within the startWindow period of the new recurrenceInterval, then no new Job will be scheduled for that interval. For recurring Jobs, you should normally specify a jobManagerTask in the jobSpecification. If you do not use jobManagerTask, you will need an external process to monitor when Jobs are created, add Tasks to the Jobs and terminate the Jobs ready for the next recurrence. The default is that the schedule does not recur: one Job is created, within the startWindow after the doNotRunUntil time, and the schedule is complete as soon as that Job finishes. The minimum value is 1 minute. If you specify a lower value, the Batch service rejects the schedule with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).