JobOperations.ListSubtasks(String, String, DetailLevel, IEnumerable<BatchClientBehavior>) Method

Definition

Enumerates the SubtaskInformation of the specified task.

public Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.SubtaskInformation> ListSubtasks (string jobId, string taskId, Microsoft.Azure.Batch.DetailLevel detailLevel = null, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = null);
member this.ListSubtasks : string * string * Microsoft.Azure.Batch.DetailLevel * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.SubtaskInformation>

Parameters

jobId
System.String

The id of the job.

taskId
System.String

The id of the task to get.

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<SubtaskInformation>

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

Remarks

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

Applies to