ScheduledJobsClient.CreateQueryAsync Method

Definition

Namespace:

Microsoft.Azure.Devices

Assembly:

Microsoft.Azure.Devices.dll

Package:

Microsoft.Azure.Devices v2.0.0-preview002

Queries an iterable set of jobs for specified type and status.

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

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

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

Parameters

options

JobQueryOptions

The optional parameters to run with the query.

cancellationToken

CancellationToken

Task cancellation token.

Returns

Task<QueryResponse<ScheduledJob>>

An iterable set of jobs for specified type and status.

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 cancellationToken has requested cancellation.