Share via

Device Registration State - Query

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

Ottiene lo stato di registrazione dei dispositivi in questo enrollmentGroup.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
id
 path True

string

ID gruppo di registrazione.
api-version
 query True

string

Versione dell'API da usare per la richiesta. Le versioni supportate includono: 2021-10-01

Intestazione della richiesta

Nome Necessario Tipo Descrizione
x-ms-max-item-count

integer

int32

Pagesize
x-ms-continuation

string

token di continuazione

Risposte

Nome Tipo Descrizione
200 OK

DeviceRegistrationState[]

Operazione riuscita

Headers

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

ProvisioningServiceErrorDetails

Risposta di errore

Headers

x-ms-error-code: string

Definizioni

Nome Descrizione
DeviceRegistrationState

Stato di registrazione del dispositivo.
ProvisioningServiceErrorDetails

Contiene le proprietà di un errore restituito dal servizio di provisioning hub IoT di Azure.

DeviceRegistrationState

Stato di registrazione del dispositivo.

Nome Tipo Descrizione
assignedHub

string

Assegnato hub IoT di Azure.
createdDateTimeUtc

string

La registrazione crea data e ora (in formato UTC).
deviceId

string

ID dispositivo.
errorCode

integer

Codice di errore.
errorMessage

string

Messaggio di errore.
etag

string

Tag di entità associato alla risorsa.
lastUpdatedDateTimeUtc

string

Data dell'ultimo aggiornamento (in formato UTC).
payload

object

registrationId

string

Questo ID viene usato per identificare in modo univoco una registrazione del dispositivo di una registrazione. Stringa senza distinzione tra maiuscole e minuscole (fino a 128 caratteri) di caratteri alfanumerici più determinati caratteri speciali: . _ -. Nessun carattere speciale consentito all'inizio o alla fine.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Stato della registrazione.
substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment
  • reprovisionedToInitialAssignment

Stato secondario per i dispositivi 'Assegnati'. I valori possibili includono : 'initialAssignment': il dispositivo è stato assegnato a un hub IoT per la prima volta, 'deviceDataMigrated': il dispositivo è stato assegnato a un hub IoT diverso e i relativi dati del dispositivo sono stati migrati dall'hub IoT assegnato in precedenza. I dati del dispositivo sono stati rimossi dall'hub IoT assegnato in precedenza, 'deviceDataReset': il dispositivo è stato assegnato a un hub IoT diverso e i relativi dati del dispositivo sono stati popolati dallo stato iniziale archiviato nella registrazione. I dati del dispositivo sono stati rimossi dall'hub IoT assegnato in precedenza, 'reprovisionedToInitialAssignment': è stato eseguito di nuovo il provisioning del dispositivo in un hub IoT assegnato in precedenza.

ProvisioningServiceErrorDetails

Contiene le proprietà di un errore restituito dal servizio di provisioning hub IoT di Azure.

Nome Tipo Descrizione
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string