Iot Hub Resource - Get Job

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 https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs/{jobId}?api-version=2018-04-01

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The subscription identifier.

resourceGroupName
path True
  • string

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

resourceName
path True
  • string

The name of the IoT hub.

jobId
path True
  • string

The job identifier.

api-version
query True
  • string

The version of the API.

Responses

Name Type Description
200 OK

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

Other Status Codes

DefaultErrorResponse

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

IotHubResource_GetJob

Sample Request

GET https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/jobs/test?api-version=2018-04-01

Sample Response

{
  "jobId": "test",
  "startTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT",
  "endTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT",
  "type": "unknown",
  "status": "unknown"
}

Definitions

ErrorDetails

Error details.

JobResponse

The properties of the Job Response object.

JobStatus

The status of the job.

JobType

The type of the job.

ErrorDetails

Error details.

Name Type Description
code
  • string

The error code.

details
  • string

The error details.

httpStatusCode
  • string

The HTTP status code.

message
  • string

The error message.

JobResponse

The properties of the Job Response object.

Name Type Description
endTimeUtc
  • string

The time the job stopped processing.

failureReason
  • string

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

jobId
  • string

The job identifier.

parentJobId
  • string

The job identifier of the parent job, if any.

startTimeUtc
  • string

The start time of the job.

status

The status of the job.

statusMessage
  • string

The status message for the job.

type

The type of the job.

JobStatus

The status of the job.

Name Type Description
cancelled
  • string
completed
  • string
enqueued
  • string
failed
  • string
running
  • string
unknown
  • string

JobType

The type of the job.

Name Type Description
backup
  • string
export
  • string
factoryResetDevice
  • string
firmwareUpdate
  • string
import
  • string
readDeviceProperties
  • string
rebootDevice
  • string
unknown
  • string
updateDeviceConfiguration
  • string
writeDeviceProperties
  • string