Sdílet prostřednictvím

Device Registration State - Get

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

Získá stav registrace zařízení.

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

Parametry identifikátoru URI

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

string

ID registrace.
api-version
 query True

string

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

Odpovědi

Name Typ Description
200 OK

DeviceRegistrationState

Success
Other Status Codes

ProvisioningServiceErrorDetails

Odpověď na chybu

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.

DeviceRegistrationState

Stav registrace zařízení.

Name Typ Description
assignedHub

string

Přiřazeno Azure IoT Hub.
createdDateTimeUtc

string

Registrace vytvoří datum a čas (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 poslední aktualizace (v UTC)
payload

object

registrationId

string

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

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

Dílčí stav pro přiřazená 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í byla odebrána z dříve přiřazeného centra IoT, deviceDataReset: Zařízení bylo přiřazeno k jinému centru IoT a jeho data zařízení se naplnila z počátečního stavu uloženého v registraci. Data zařízení byla odebrána z dříve přiřazeného centra IoT, reprovisionedToInitialAssignment: Zařízení bylo znovu zřízeno na dříve přiřazené centrum IoT.

ProvisioningServiceErrorDetails

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

Name Typ Description
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string