QueryClient.CreateJobsQueryAsync(JobQueryOptions, CancellationToken) Method

Reference

Definition

Namespace:: Microsoft.Azure.Devices

Assembly:: Microsoft.Azure.Devices.dll

Package:: Microsoft.Azure.Devices v2.0.0-preview002

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.

Query all jobs or query jobs by type and/or status.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.QueryResponse<Microsoft.Azure.Devices.ScheduledJob>> CreateJobsQueryAsync (Microsoft.Azure.Devices.JobQueryOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member CreateJobsQueryAsync : Microsoft.Azure.Devices.JobQueryOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.QueryResponse<Microsoft.Azure.Devices.ScheduledJob>>
override this.CreateJobsQueryAsync : Microsoft.Azure.Devices.JobQueryOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.QueryResponse<Microsoft.Azure.Devices.ScheduledJob>>

Public Overridable Function CreateJobsQueryAsync (Optional options As JobQueryOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of QueryResponse(Of ScheduledJob))

Parameters

options: JobQueryOptions

The optional parameters to run the query with.

cancellationToken: CancellationToken

Task cancellation token.

Returns

Task<QueryResponse<ScheduledJob>>

An iterable set of the queried jobs.

Exceptions

IotHubServiceException

If IoT hub responded to the request with a non-successful status code. For example, if the provided request was throttled, IotHubServiceException with ThrottlingException is thrown. For a complete list of possible error cases, see IotHubServiceErrorCode.

HttpRequestException

If the HTTP request fails due to an underlying issue such as network connectivity, DNS failure, or server certificate validation.

OperationCanceledException

If the provided cancellation token has requested cancellation.

Examples


  QueryResponse<ScheduledJob> queriedJobs = await iotHubServiceClient.Query.CreateJobsQueryAsync();
  while (await queriedJobs.MoveNextAsync())
  {
      Console.WriteLine(queriedJobs.Current.JobId);
  }

Applies to