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

Device Registration State - Query

  • 参考
Service:
IoT Hub Device Provisioning Service
API Version:
2021-10-01

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

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

URI 参数

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

string

注册组 ID。
api-version
 query True

string

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

请求头

名称 必需 类型 说明
x-ms-max-item-count

integer

int32

pageSize
x-ms-continuation

string

继续标记

响应

名称 类型 说明
200 OK

DeviceRegistrationState[]

成功

Headers

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

ProvisioningServiceErrorDetails

错误响应

Headers

x-ms-error-code: string

定义

名称 说明
DeviceRegistrationState

设备注册状态。
ProvisioningServiceErrorDetails

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

DeviceRegistrationState

设备注册状态。

名称 类型 说明
assignedHub

string

已分配Azure IoT 中心。
createdDateTimeUtc

string

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

string

设备 ID。
errorCode

integer

错误代码。
errorMessage

string

错误消息。
etag

string

与资源关联的实体标记。
lastUpdatedDateTimeUtc

string

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

object

registrationId

string

此 ID 用于唯一标识注册的设备注册。 不区分大小写的字符串 (最多 128 个字符，) 字母数字字符加上某些特殊字符：。 _ -. 开头或结尾不允许使用特殊字符。
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 中心预配服务返回的错误的属性。

名称 类型 说明
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string