Dela via

Device Registration State - Query

  • Referens
Tjänst:
IoT Hub Device Provisioning Service
API-version:
2021-10-01

Hämtar registreringstillståndet för enheter i den här registreringsgruppen.

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

URI-parametrar

Name I Obligatorisk Typ Description
id
 path True

string

Registreringsgrupp-ID.
api-version
 query True

string

DEN API-version som ska användas för begäran. Versioner som stöds är: 2021-10-01

Begärandehuvud

Name Obligatorisk Typ Description
x-ms-max-item-count

integer (int32)

pageSize
x-ms-continuation

string

fortsättningstoken

Svar

Name Typ Description
200 OK

DeviceRegistrationState[]

Framgång

Sidhuvuden

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

ProvisioningServiceErrorDetails

Felsvar

Sidhuvuden

x-ms-error-code: string

Definitioner

Name Description
DeviceRegistrationState

Tillstånd för enhetsregistrering.
ProvisioningServiceErrorDetails

Innehåller egenskaperna för ett fel som returneras av Azure IoT Hub Provisioning Service.

DeviceRegistrationState

Objekt

Tillstånd för enhetsregistrering.

Name Typ Description
assignedHub

string

Tilldelad Azure IoT Hub.
createdDateTimeUtc

string (date-time)

Registrering skapa datumtid (i UTC).
deviceId

string

Enhets-ID.
errorCode

integer (int32)

Felkod.
errorMessage

string

Felmeddelande.
etag

string

Entitetstaggen som är associerad med resursen.
lastUpdatedDateTimeUtc

string (date-time)

Senast uppdaterad datumtid (i UTC).
payload

object

registrationId

string

Det här ID:t används för att unikt identifiera en enhetsregistrering av en registrering. En skiftlägeskänslig sträng (upp till 128 tecken lång) med alfanumeriska tecken plus vissa specialtecken : . _ -. Inga specialtecken tillåts i början eller slutet.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Registreringsstatus.
substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment
  • reprovisionedToInitialAssignment

Understatus för "Tilldelade" enheter. Möjliga värden är – "initialAssignment": Enheten har tilldelats till en IoT-hubb för första gången, "deviceDataMigrated": Enheten har tilldelats till en annan IoT-hubb och dess enhetsdata har migrerats från den tidigare tilldelade IoT-hubben. Enhetsdata har tagits bort från den tidigare tilldelade IoT-hubben deviceDataReset: Enheten har tilldelats till en annan IoT-hubb och dess enhetsdata fylldes i från det ursprungliga tillståndet som lagrades i registreringen. Enhetsdata togs bort från den tidigare tilldelade IoT-hubben , "reprovisionedToInitialAssignment": Enheten har återetablerats till en tidigare tilldelad IoT-hubb.

ProvisioningServiceErrorDetails

Objekt

Innehåller egenskaperna för ett fel som returneras av Azure IoT Hub Provisioning Service.

Name Typ Description
errorCode

integer (int32)

info

object

message

string

timestampUtc

string (date-time)

trackingId

string