Freigeben über

Device Registration State - Query

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

Ruft den Registrierungsstatus von Geräten in dieser enrollmentGroup ab.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
id
 path True

string

Registrierungsgruppen-ID.
api-version
 query True

string

API-Version, die für die Anforderung verwendet werden soll. Unterstützte Versionen: 2021-10-01

Anforderungsheader

Name Erforderlich Typ Beschreibung
x-ms-max-item-count

integer

int32

pageSize
x-ms-continuation

string

Fortsetzungstoken

Antworten

Name Typ Beschreibung
200 OK

DeviceRegistrationState[]

Erfolg

Header

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

ProvisioningServiceErrorDetails

Fehlerantwort

Header

x-ms-error-code: string

Definitionen

Name Beschreibung
DeviceRegistrationState

Geräteregistrierungsstatus.
ProvisioningServiceErrorDetails

Enthält die Eigenschaften eines Fehlers, der vom Azure IoT Hub Provisioning Service zurückgegeben wird.

DeviceRegistrationState

Geräteregistrierungsstatus.

Name Typ Beschreibung
assignedHub

string

Zugewiesene Azure IoT Hub.
createdDateTimeUtc

string

Erstellungsdatum der Registrierung (in UTC).
deviceId

string

Geräte-ID.
errorCode

integer

Fehlercode
errorMessage

string

Fehlermeldung.
etag

string

Das Entitätstag, das der Ressource zugeordnet ist.
lastUpdatedDateTimeUtc

string

Datum der letzten Aktualisierung (in UTC).
payload

object

registrationId

string

Diese ID wird verwendet, um eine Geräteregistrierung einer Registrierung eindeutig zu identifizieren. Eine Zeichenfolge ohne Berücksichtigung der Groß-/Kleinschreibung (bis zu 128 Zeichen) mit alphanumerischen Zeichen plus bestimmten Sonderzeichen : . _ -. Am Anfang oder Ende sind keine Sonderzeichen zulässig.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Registrierungs-status.
substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment
  • reprovisionedToInitialAssignment

Unterstatus für "Zugewiesene" Geräte. Mögliche Werte sind : "initialAssignment": Das Gerät wurde zum ersten Mal einem IoT-Hub zugewiesen, "deviceDataMigrated": Das Gerät wurde einem anderen IoT-Hub zugewiesen, und seine Gerätedaten wurden vom zuvor zugewiesenen IoT Hub migriert. Gerätedaten wurden aus dem zuvor zugewiesenen IoT-Hub "deviceDataReset" entfernt: Das Gerät wurde einem anderen IoT-Hub zugewiesen, und die Gerätedaten wurden aus dem ursprünglichen Zustand aufgefüllt, der in der Registrierung gespeichert wurde. Gerätedaten wurden aus dem zuvor zugewiesenen IoT-Hub "reprovisionedToInitialAssignment" entfernt: Das Gerät wurde für einen zuvor zugewiesenen IoT Hub erneut bereitgestellt.

ProvisioningServiceErrorDetails

Enthält die Eigenschaften eines Fehlers, der vom Azure IoT Hub Provisioning Service zurückgegeben wird.

Name Typ Beschreibung
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string