您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

Device Registration State - Query

获取此 enrollmentGroup 中设备的注册状态。

POST https://your-dps.azure-devices-provisioning.net/registrations/{id}/query?api-version=2021-06-01

URI 参数

Name In Required Type Description
id
path True
  • string

注册组 ID。

api-version
query True
  • string

要用于请求的 API 版本。 支持的版本包括:2021-06-01

请求头

Name Required Type Description
x-ms-max-item-count
  • integer
int32

pageSize

x-ms-continuation
  • string

继续标记

响应

Name Type Description
200 OK

成功

Headers

  • x-ms-continuation: string
  • x-ms-max-item-count: integer
  • x-ms-item-type: string
Other Status Codes

错误响应

定义

DeviceRegistrationState

设备注册状态。

ProvisioningServiceErrorDetails

包含中心预配服务返回Azure IoT的属性。

DeviceRegistrationState

设备注册状态。

Name Type Description
assignedHub
  • string

已Azure IoT中心。

createdDateTimeUtc
  • string

注册创建日期时间 (UTC) 。

deviceId
  • string

设备 ID。

errorCode
  • integer

错误代码。

errorMessage
  • string

错误消息。

etag
  • string

与资源关联的实体标记。

lastUpdatedDateTimeUtc
  • string

上次更新的日期时间 (UTC) 。

payload
  • object

从 Webhook 返回到设备的自定义分配有效负载。

registrationId
  • string

注册 ID 是小写的字母数字,并且可包含连字符。

status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

注册状态。

substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment
  • reprovisionedToInitialAssignment

"已分配"设备的子状态。 可能的值包括 - 'initialAssignment':设备已首次分配到 IoT 中心,"deviceDataMigrated":设备已分配到其他 IoT 中心,其设备数据已从以前分配的 IoT 中心迁移。 设备数据已从以前分配的 IoT 中心"deviceDataReset"中删除:设备已分配到其他 IoT 中心,其设备数据已从注册中存储的初始状态填充。 设备数据已从以前分配的 IoT 中心"reprovisionedToInitialAssignment"中删除:设备已重新预配到以前分配的 IoT 中心。

ProvisioningServiceErrorDetails

包含中心预配服务返回Azure IoT的属性。

Name Type Description
errorCode
  • integer
info
  • object
message
  • string
timestampUtc
  • string
trackingId
  • string