IJobOperations.ListFromJobScheduleWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.Batch.Protocol

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.2.0

Source:

IJobOperations.cs

Lists the Jobs that have been created under the specified Job Schedule.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Batch.Protocol.Models.CloudJob>,Microsoft.Azure.Batch.Protocol.Models.JobListFromJobScheduleHeaders>> ListFromJobScheduleWithHttpMessagesAsync (string jobScheduleId, Microsoft.Azure.Batch.Protocol.Models.JobListFromJobScheduleOptions jobListFromJobScheduleOptions = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ListFromJobScheduleWithHttpMessagesAsync : string * Microsoft.Azure.Batch.Protocol.Models.JobListFromJobScheduleOptions * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Batch.Protocol.Models.CloudJob>, Microsoft.Azure.Batch.Protocol.Models.JobListFromJobScheduleHeaders>>

Public Function ListFromJobScheduleWithHttpMessagesAsync (jobScheduleId As String, Optional jobListFromJobScheduleOptions As JobListFromJobScheduleOptions = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of IPage(Of CloudJob), JobListFromJobScheduleHeaders))

Parameters

jobScheduleId

String

The ID of the Job Schedule from which you want to get a list of Jobs.

jobListFromJobScheduleOptions

JobListFromJobScheduleOptions

Additional parameters for the operation

customHeaders

Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<IPage<CloudJob>,JobListFromJobScheduleHeaders>>

Exceptions

BatchErrorException

Thrown when the operation returned an invalid status code

SerializationException

Thrown when unable to deserialize the response

ValidationException

Thrown when a required parameter is null