Sign in

v2

latestSwagger 2.0raw.githubusercontent.com2021-04-273265113.0 KB
GET

Get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry

Get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

get/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs/{jobId}

Path parameters

subscriptionIdstring required

The subscription identifier.

resourceGroupNamestring required

The name of the resource group that contains the IoT hub.

resourceNamestring required

The name of the IoT hub.

jobIdstring required

The job identifier.

Query parameters

api-versionstring required

The version of the API.

Response

This is a synchronous operation. The response contains a JSON-serialized description of the job in the IoT hub.

jobIdstring

The job identifier.

startTimeUtcstring date-time-rfc1123

The start time of the job.

endTimeUtcstring date-time-rfc1123

The time the job stopped processing.

type'unknown' | 'export' | 'import' | 'backup' | 'readDeviceProperties' | 'writeDeviceProperties' | 'updateDeviceConfiguration' | 'rebootDevice' | 'factoryResetDevice' | 'firmwareUpdate'

The type of the job.

status'unknown' | 'enqueued' | 'running' | 'completed' | 'failed' | 'cancelled'

The status of the job.

failureReasonstring

If status == failed, this string containing the reason for the failure.

statusMessagestring

The status message for the job.

parentJobIdstring

The job identifier of the parent job, if any.