Share via

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 參數

名稱 位於 必要 類型 Description
id
 path True

string

註冊群組標識碼。
api-version
 query True

string

要用於要求的 API 版本。 支援的版本包括：2021-10-01

要求標頭

名稱 必要 類型 Description
x-ms-max-item-count

integer

int32

pageSize
x-ms-continuation

string

接續令牌

回應

名稱 類型 Description
200 OK

DeviceRegistrationState[]

Success

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

定義

名稱 Description
DeviceRegistrationState

裝置註冊狀態。
ProvisioningServiceErrorDetails

包含 Azure IoT 中樞 布建服務所傳回之錯誤的屬性。

DeviceRegistrationState

裝置註冊狀態。

名稱 類型 Description
assignedHub

string

指派的 Azure IoT 中樞。
createdDateTimeUtc

string

註冊會以 UTC) 建立日期時間 (。
deviceId

string

裝置識別碼。
errorCode

integer

錯誤碼。
errorMessage

string

錯誤訊息。
etag

string

與資源相關聯的實體標籤。
lastUpdatedDateTimeUtc

string

上次更新的日期時間 (UTC) 。
payload

object

registrationId

string

此標識碼用來唯一識別註冊的裝置註冊。 不區分大小寫的字串 (最多 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 中樞 布建服務所傳回之錯誤的屬性。

名稱 類型 Description
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string