CloudJobSchedule.ListJobs Method

Definition

Enumerates the jobs created under this CloudJobSchedule.

public Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.CloudJob> ListJobs (Microsoft.Azure.Batch.DetailLevel detailLevel = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);
member this.ListJobs : Microsoft.Azure.Batch.DetailLevel * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.CloudJob>
Public Function ListJobs (Optional detailLevel As DetailLevel = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing) As IPagedEnumerable(Of CloudJob)

Parameters

detailLevel
DetailLevel

A DetailLevel used for filtering the list and for controlling which properties are retrieved from the service.

additionalBehaviors
System.Collections.Generic.IEnumerable<BatchClientBehavior>

A collection of BatchClientBehavior instances that are applied to the Batch service request after the CustomBehaviors and detailLevel.

Returns

IPagedEnumerable<CloudJob>

An IPagedEnumerable<T> that can be used to enumerate jobs asynchronously or synchronously.

Remarks

This method returns immediately; the jobs are retrieved from the Batch service only when the collection is enumerated. Retrieval is non-atomic; jobs are retrieved in pages during enumeration of the collection.

Applies to