Service - Query Jobs

Query an IoT hub to retrieve information regarding jobs using the IoT Hub query language
Query an IoT hub to retrieve information regarding jobs using the IoT Hub query language. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. Pagination of results is supported. This returns information about jobs only.

GET https://fully-qualified-iothubname.azure-devices.net/jobs/v2/query?api-version=2018-06-30
GET https://fully-qualified-iothubname.azure-devices.net/jobs/v2/query?jobType={jobType}&jobStatus={jobStatus}&api-version=2018-06-30

URI Parameters

Name In Required Type Description
jobType
query
  • string

Job Type.

jobStatus
query
  • string

Job Status.

api-version
query True
  • string

Version of the Api.

Responses

Name Type Description
200 OK

Returns the Query Result object

Definitions

QueryResult

The query result.

Name Type Description
continuationToken
  • string

Request continuation token.

items
  • object[]

The query result items, as a collection.

type enum:
  • deviceJob
  • deviceRegistration
  • enrollment
  • enrollmentGroup
  • jobResponse
  • raw
  • twin
  • unknown

The query result type.