Device Registration State - Query
この enrollmentGroup 内のデバイスの登録状態を取得します。
POST https://your-dps.azure-devices-provisioning.net/registrations/{id}/query?api-version=2021-06-01URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
id
|
path | True |
string |
登録グループ ID。 |
|
api-version
|
query | True |
string |
要求で使用する API のバージョン。 サポートされているバージョンは次のとおりです: 2021-06-01 |
要求ヘッダー
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| x-ms-max-item-count |
integer int32 |
PageSize |
|
| x-ms-continuation |
string |
継続トークン |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
Success Headers
|
|
| Other Status Codes |
エラー応答 |
定義
| 名前 | 説明 |
|---|---|
|
Device |
デバイス登録の状態。 |
|
Provisioning |
Azure IoT Hub Provisioning Service によって返されるエラーのプロパティを格納します。 |
DeviceRegistrationState
デバイス登録の状態。
| 名前 | 型 | 説明 |
|---|---|---|
| assignedHub |
string |
割り当てられたAzure IoT Hub。 |
| createdDateTimeUtc |
string |
登録の作成日時 (UTC)。 |
| deviceId |
string |
デバイス ID。 |
| errorCode |
integer |
エラー コード。 |
| errorMessage |
string |
エラー メッセージ。 |
| etag |
string |
リソースに関連付けられているエンティティ タグ。 |
| lastUpdatedDateTimeUtc |
string |
最終更新日時 (UTC)。 |
| payload |
object |
Webhook からデバイスに返されるカスタム割り当てペイロード。 |
| registrationId |
string |
登録 ID には、英数字、小文字と、必要に応じてハイフンを含めます。 |
| status |
enum:
|
登録の状態。 |
| substatus |
enum:
|
"割り当て済み" デバイスのサブステータス。 使用可能な値には、"initialAssignment": デバイスが初めて IoT ハブに割り当てられた、"deviceDataMigrated": デバイスが別の IoT ハブに割り当てられ、そのデバイス データが以前に割り当てられた IoT ハブから移行されました。 デバイス データは、以前に割り当てられた IoT ハブ 'deviceDataReset' から削除されました。デバイスは別の IoT ハブに割り当てられ、そのデバイス データは登録に格納されている初期状態から設定されました。 以前に割り当てられた IoT ハブ 'reprovisionedToInitialAssignment' からデバイス データが削除されました。デバイスは、以前に割り当てられた IoT ハブに再プロビジョニングされました。 |
ProvisioningServiceErrorDetails
Azure IoT Hub Provisioning Service によって返されるエラーのプロパティを格納します。
| 名前 | 型 | 説明 |
|---|---|---|
| errorCode |
integer |
|
| info |
object |
|
| message |
string |
|
| timestampUtc |
string |
|
| trackingId |
string |