Device Registration State - Query
Lekéri az eszközök regisztrációs állapotát ebben a enrollmentGroupban.
POST https://your-dps.azure-devices-provisioning.net/registrations/{id}/query?api-version=2021-10-01
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
id
|
path | True |
string |
Regisztrációs csoport azonosítója. |
api-version
|
query | True |
string |
A kéréshez használni kívánt API-verzió. Támogatott verziók: 2021.10.01. |
Kérelem fejléce
Name | Kötelező | Típus | Description |
---|---|---|---|
x-ms-max-item-count |
integer int32 |
pageSize |
|
x-ms-continuation |
string |
folytatási jogkivonat |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
Siker Headers
|
|
Other Status Codes |
Hibaválasz Headers x-ms-error-code: string |
Definíciók
Name | Description |
---|---|
Device |
Eszközregisztrációs állapot. |
Provisioning |
A Azure IoT Hub kiépítési szolgáltatás által visszaadott hiba tulajdonságait tartalmazza. |
DeviceRegistrationState
Eszközregisztrációs állapot.
Name | Típus | Description |
---|---|---|
assignedHub |
string |
Hozzárendelt Azure IoT Hub. |
createdDateTimeUtc |
string |
A regisztráció dátum-létrehozási időpontja (UTC-ben). |
deviceId |
string |
Eszközazonosító. |
errorCode |
integer |
Hibakód. |
errorMessage |
string |
Hibaüzenet. |
etag |
string |
Az erőforráshoz társított entitáscímke. |
lastUpdatedDateTimeUtc |
string |
Utolsó frissítés dátuma (UTC-ben). |
payload |
object |
|
registrationId |
string |
Ez az azonosító egy regisztráció eszközregisztrációjának egyedi azonosítására szolgál. Kis- és nagybetűk megkülönböztetése (legfeljebb 128 karakter hosszú) alfanumerikus karakterekből és bizonyos speciális karakterekből: . _ -. A kezdéskor és a végén nem engedélyezett speciális karakterek használata. |
status |
enum:
|
Regisztráció állapota. |
substatus |
enum:
|
"Hozzárendelt" eszközök alállapota. Lehetséges értékek: - 'initialAssignment': Az eszköz első alkalommal lett hozzárendelve egy IoT Hubhoz(deviceDataMigrated): Az eszköz egy másik IoT Hubhoz lett hozzárendelve, és az eszköz adatai át lettek migrálva a korábban hozzárendelt IoT Hubról. Az eszközadatok el lettek távolítva a korábban hozzárendelt IoT Hubból( deviceDataReset): Az eszköz egy másik IoT Hubhoz lett hozzárendelve, és az eszköz adatai a regisztrációban tárolt kezdeti állapotból lettek feltöltve. Az eszköz adatai el lettek távolítva a korábban hozzárendelt IoT Hubról, a "reprovisionedToInitialAssignment" szolgáltatásból: Az eszközt újra kiépítették egy korábban hozzárendelt IoT Hubra. |
ProvisioningServiceErrorDetails
A Azure IoT Hub kiépítési szolgáltatás által visszaadott hiba tulajdonságait tartalmazza.
Name | Típus | Description |
---|---|---|
errorCode |
integer |
|
info |
object |
|
message |
string |
|
timestampUtc |
string |
|
trackingId |
string |