Service - Get Import Export Jobs

Gets the status of all import/export jobs in an iot hub
Gets the status of all import/export jobs in an iot hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information.

GET https://fully-qualified-iothubname.azure-devices.net/jobs?api-version=2018-06-30

URI Parameters

Name In Required Type Description
api-version
query True
  • string

Version of the Api.

Responses

Name Type Description
200 OK

Returns the array of JobProperties object

Definitions

JobProperties

Name Type Description
endTimeUtc
  • string

System generated. Ignored at creation. Represents the time the job stopped processing.

excludeKeysInExport
  • boolean

Optional for export jobs; ignored for other jobs. Default: false. If false, authorization keys are included in export output. Keys are exported as null otherwise.

failureReason
  • string

System genereated. Ignored at creation. If status == failure, this represents a string containing the reason.

inputBlobContainerUri
  • string

URI containing SAS token to a blob container that contains registry data to sync.

inputBlobName
  • string

The blob name to be used when importing from the provided input blob container.

jobId
  • string

System generated. Ignored at creation.

outputBlobContainerUri
  • string

URI containing SAS token to a blob container. This is used to output the status of the job and the results.

outputBlobName
  • string

The name of the blob that will be created in the provided output blob container. This blob will contain the exported device registry information for the IoT Hub.

progress
  • integer

System generated. Ignored at creation. Represents the percentage of completion.

startTimeUtc
  • string

System generated. Ignored at creation.

status enum:
  • cancelled
  • completed
  • enqueued
  • failed
  • queued
  • running
  • scheduled
  • unknown

System generated. Ignored at creation.

type enum:
  • backup
  • export
  • factoryResetDevice
  • failoverDataCopy
  • firmwareUpdate
  • import
  • readDeviceProperties
  • rebootDevice
  • restoreFromBackup
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • unknown
  • updateDeviceConfiguration
  • writeDeviceProperties

Required. The type of job to execute.