Device Registration State - Query

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-06-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-06-01

Name	Obligatorisk	Typ	Description
x-ms-max-item-count		integer int32	pageSize
x-ms-continuation		string	fortsättningstoken

Name	Typ	Description
200 OK	DeviceRegistrationState[]	Klart Headers x-ms-continuation: string x-ms-max-item-count: integer x-ms-item-type: string
Other Status Codes	ProvisioningServiceErrorDetails	Felsvar

Name

Typ

Description

200 OK

Klart

Headers

Other Status Codes

Felsvar

Name	Description
DeviceRegistrationState	Enhetsregistreringstillstånd.
ProvisioningServiceErrorDetails	Innehåller egenskaperna för ett fel som returneras av Azure IoT Hub Provisioning Service.

Enhetsregistreringstillstånd.

Name	Typ	Description
assignedHub	string	Tilldelad Azure IoT Hub.
createdDateTimeUtc	string	Registrering skapa datumtid (i UTC).
deviceId	string	Enhets-ID.
errorCode	integer	Felkod.
errorMessage	string	Felmeddelande.
etag	string	Entitetstaggen som är associerad med resursen.
lastUpdatedDateTimeUtc	string	Senast uppdaterad datumtid (i UTC).
payload	object	Anpassad allokeringsnyttolast som returneras från webhooken till enheten.
registrationId	string	Registrerings-ID:t är alfanumeriskt, gemener och kan innehålla bindestreck.
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 togs 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.

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