Sdílet prostřednictvím

Device Registration State - Query

  • Reference
Služba:
IoT Hub Device Provisioning Service
Verze rozhraní API:
2021-10-01

Získá stav registrace zařízení v této skupině enrollmentGroup.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
id
 path True

string

ID skupiny registrací
api-version
 query True

string

Verze rozhraní API, která se má použít pro požadavek. Mezi podporované verze patří: 2021-10-01

Hlavička požadavku

Name Vyžadováno Typ Description
x-ms-max-item-count

integer

int32

Pagesize
x-ms-continuation

string

Token pro pokračování

Odpovědi

Name Typ Description
200 OK

DeviceRegistrationState[]

Success

Hlavičky

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

ProvisioningServiceErrorDetails

Chybová odpověď

Hlavičky

x-ms-error-code: string

Definice

Name Description
DeviceRegistrationState

Stav registrace zařízení.
ProvisioningServiceErrorDetails

Obsahuje vlastnosti chyby vrácené službou Azure IoT Hub Provisioning Service.

DeviceRegistrationState

Stav registrace zařízení.

Name Typ Description
assignedHub

string

Přiřazeno Azure IoT Hub.
createdDateTimeUtc

string

Datum vytvoření registrace (v UTC)
deviceId

string

ID zařízení.
errorCode

integer

Kód chyby
errorMessage

string

Chybová zpráva.
etag

string

Značka entity přidružená k prostředku.
lastUpdatedDateTimeUtc

string

Datum a čas poslední aktualizace (v UTC)
payload

object

registrationId

string

Toto ID slouží k jednoznačné identifikaci registrace zařízení. Řetězec alfanumerických znaků nerozlišující velká a malá písmena (až 128 znaků dlouhý) plus určité speciální znaky: . _ -. Na začátku ani na konci nejsou povoleny žádné speciální znaky.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Stav registrace.
substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment
  • reprovisionedToInitialAssignment

Dílčí stav přiřazených zařízení. Mezi možné hodnoty patří initialAssignment: Zařízení bylo poprvé přiřazeno ke službě IoT Hub, deviceDataMigrated: Zařízení bylo přiřazeno k jinému centru IoT a data zařízení se migrovala z dříve přiřazeného centra IoT. Data zařízení se odebrala z dříve přiřazeného centra IoT, deviceDataReset: Zařízení bylo přiřazeno k jinému centru IoT a data zařízení se naplnila od počátečního stavu uloženého v registraci. Data zařízení se odebrala z dříve přiřazeného centra IoT, reprovisionedToInitialAssignment: Zařízení bylo znovu zřízeno do dříve přiřazeného centra IoT.

ProvisioningServiceErrorDetails

Obsahuje vlastnosti chyby vrácené službou Azure IoT Hub Provisioning Service.

Name Typ Description
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string