BatchClient.GetJobsFromScheduleAsync Method
Definition
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.
Overloads
| Name | Description |
|---|---|
| GetJobsFromScheduleAsync(String, Nullable<TimeSpan>, Nullable<DateTimeOffset>, Nullable<Int32>, String, IEnumerable<String>, IEnumerable<String>, RequestContext) |
[Protocol Method] Lists the Jobs that have been created under the specified Job Schedule.
|
| GetJobsFromScheduleAsync(String, Nullable<TimeSpan>, Nullable<DateTimeOffset>, Nullable<Int32>, String, IEnumerable<String>, IEnumerable<String>, CancellationToken) |
Lists the Jobs that have been created under the specified Job Schedule. |
GetJobsFromScheduleAsync(String, Nullable<TimeSpan>, Nullable<DateTimeOffset>, Nullable<Int32>, String, IEnumerable<String>, IEnumerable<String>, RequestContext)
- Source:
- BatchClient.cs
[Protocol Method] Lists the Jobs that have been created under the specified Job Schedule.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual Azure.AsyncPageable<BinaryData> GetJobsFromScheduleAsync(string jobScheduleId, TimeSpan? timeout, DateTimeOffset? requestDate, int? maxResults, string filter, System.Collections.Generic.IEnumerable<string> select, System.Collections.Generic.IEnumerable<string> expand, Azure.RequestContext context);abstract member GetJobsFromScheduleAsync : string * Nullable<TimeSpan> * Nullable<DateTimeOffset> * Nullable<int> * string * seq<string> * seq<string> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetJobsFromScheduleAsync : string * Nullable<TimeSpan> * Nullable<DateTimeOffset> * Nullable<int> * string * seq<string> * seq<string> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>Public Overridable Function GetJobsFromScheduleAsync (jobScheduleId As String, timeout As Nullable(Of TimeSpan), requestDate As Nullable(Of DateTimeOffset), maxResults As Nullable(Of Integer), filter As String, select As IEnumerable(Of String), expand As IEnumerable(Of String), context As RequestContext) As AsyncPageable(Of BinaryData)Parameters
- jobScheduleId
- String
The ID of the Job Schedule from which you want to get a list of Jobs.
The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
- requestDate
- Nullable<DateTimeOffset>
The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
The maximum number of items to return in the response. A maximum of 1000 applications can be returned.
- filter
- String
An OData $filter clause. For more information on constructing this filter, see https://dotnet.territoriali.olinfo.it/rest/api/batchservice/odata-filters-in-batch#list-jobs-in-a-job-schedule.
- select
- IEnumerable<String>
An OData $select clause.
- expand
- IEnumerable<String>
An OData $expand clause.
- context
- RequestContext
The request options, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The response returned from the service.
Exceptions
jobScheduleId is null.
jobScheduleId is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Applies to
GetJobsFromScheduleAsync(String, Nullable<TimeSpan>, Nullable<DateTimeOffset>, Nullable<Int32>, String, IEnumerable<String>, IEnumerable<String>, CancellationToken)
- Source:
- BatchClient.cs
Lists the Jobs that have been created under the specified Job Schedule.
public virtual Azure.AsyncPageable<Azure.Compute.Batch.BatchJob> GetJobsFromScheduleAsync(string jobScheduleId, TimeSpan? timeout = default, DateTimeOffset? requestDate = default, int? maxResults = default, string filter = default, System.Collections.Generic.IEnumerable<string> select = default, System.Collections.Generic.IEnumerable<string> expand = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetJobsFromScheduleAsync : string * Nullable<TimeSpan> * Nullable<DateTimeOffset> * Nullable<int> * string * seq<string> * seq<string> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Compute.Batch.BatchJob>
override this.GetJobsFromScheduleAsync : string * Nullable<TimeSpan> * Nullable<DateTimeOffset> * Nullable<int> * string * seq<string> * seq<string> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Compute.Batch.BatchJob>Public Overridable Function GetJobsFromScheduleAsync (jobScheduleId As String, Optional timeout As Nullable(Of TimeSpan) = Nothing, Optional requestDate As Nullable(Of DateTimeOffset) = Nothing, Optional maxResults As Nullable(Of Integer) = Nothing, Optional filter As String = Nothing, Optional select As IEnumerable(Of String) = Nothing, Optional expand As IEnumerable(Of String) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of BatchJob)Parameters
- jobScheduleId
- String
The ID of the Job Schedule from which you want to get a list of Jobs.
The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
- requestDate
- Nullable<DateTimeOffset>
The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
The maximum number of items to return in the response. A maximum of 1000 applications can be returned.
- filter
- String
An OData $filter clause. For more information on constructing this filter, see https://dotnet.territoriali.olinfo.it/rest/api/batchservice/odata-filters-in-batch#list-jobs-in-a-job-schedule.
- select
- IEnumerable<String>
An OData $select clause.
- expand
- IEnumerable<String>
An OData $expand clause.
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
Exceptions
jobScheduleId is null.
jobScheduleId is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
