你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Iot Hub Resource - Get Job

  • 参考
Service:
IoT Hub
API Version:
2018-04-01

从 IoT 中心获取作业的详细信息。 有关详细信息，请参阅：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 参数

名称 在 必需 类型 说明
jobId
 path True

string

作业标识符。
resourceGroupName
 path True

string

包含 IoT 中心的资源组的名称。
resourceName
 path True

string

IoT 中心的名称。
subscriptionId
 path True

string

订阅标识符。
api-version
 query True

string

API 的版本。

响应

名称 类型 说明
200 OK

JobResponse

这是一个同步操作。 响应包含 IoT 中心作业的 JSON 序列化说明。
Other Status Codes

ErrorDetails

DefaultErrorResponse

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称 说明
user_impersonation 模拟用户帐户

示例

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

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

定义

名称 说明
ErrorDetails

错误详细信息。
JobResponse

作业响应对象的属性。
JobStatus

作业的状态。
JobType

作业的类型。

ErrorDetails

错误详细信息。

名称 类型 说明
code

string

错误代码。
details

string

错误详细信息。
httpStatusCode

string

HTTP 状态代码。
message

string

错误消息。

JobResponse

作业响应对象的属性。

名称 类型 说明
endTimeUtc

string

作业停止处理的时间。
failureReason

string

如果状态 == 失败，则此字符串包含失败原因。
jobId

string

作业标识符。
parentJobId

string

父作业的作业标识符（如果有）。
startTimeUtc

string

作业的开始时间。
status

JobStatus

作业的状态。
statusMessage

string

作业的状态消息。
type

JobType

作业的类型。

JobStatus

作业的状态。

名称 类型 说明
cancelled

string

completed

string

enqueued

string

failed

string

running

string

unknown

string

JobType

作业的类型。

名称 类型 说明
backup

string

export

string

factoryResetDevice

string

firmwareUpdate

string

import

string

readDeviceProperties

string

rebootDevice

string

unknown

string

updateDeviceConfiguration

string

writeDeviceProperties

string