JobScheduleOperations.ListJobs Method

Reference

Definition

Namespace:: Microsoft.Azure.Batch

Assembly:: Microsoft.Azure.Batch.dll

Package:: Microsoft.Azure.Batch v16.2.0

Source:: JobScheduleOperations.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Enumerates the jobs created under the specified job schedule.

public Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.CloudJob> ListJobs (string jobScheduleId, Microsoft.Azure.Batch.DetailLevel detailLevel = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);

member this.ListJobs : string * Microsoft.Azure.Batch.DetailLevel * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.CloudJob>

Public Function ListJobs (jobScheduleId As String, Optional detailLevel As DetailLevel = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing) As IPagedEnumerable(Of CloudJob)

Parameters

jobScheduleId: String

The id of the job schedule.

detailLevel: DetailLevel

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

additionalBehaviors: 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