Device Registration State - Get

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

取得裝置註冊狀態。

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

URI 參數

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

string

註冊標識碼。
api-version
 query True

string

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

回應

名稱 類型 Description
200 OK

DeviceRegistrationState

Success
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