JobScheduleOperations.GetJobScheduleAsync Method

Definition

Namespace:

Microsoft.Azure.Batch

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.3.1

Source:

JobScheduleOperations.cs

Gets the specified CloudJobSchedule.

public System.Threading.Tasks.Task<Microsoft.Azure.Batch.CloudJobSchedule> GetJobScheduleAsync (string jobScheduleId, Microsoft.Azure.Batch.DetailLevel detailLevel = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);

member this.GetJobScheduleAsync : string * Microsoft.Azure.Batch.DetailLevel * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.CloudJobSchedule>

Public Function GetJobScheduleAsync (jobScheduleId As String, Optional detailLevel As DetailLevel = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of CloudJobSchedule)

Parameters

jobScheduleId

String

The id of the job schedule to get.

detailLevel

DetailLevel

A DetailLevel used 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.

cancellationToken

CancellationToken

A CancellationToken for controlling the lifetime of the asynchronous operation.

Returns

Task<CloudJobSchedule>

A CloudJobSchedule containing information about the specified Azure Batch job schedule.

Remarks

The get job schedule operation runs asynchronously.