Delen via

Device Registration State - Query

  • Referentie
Service:
IoT Hub Device Provisioning Service
API-versie:
2021-10-01

Hiermee haalt u de registratiestatus van apparaten in deze enrollmentGroup op.

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

URI-parameters

Name In Vereist Type Description
id
 path True

string

Id van inschrijvingsgroep.
api-version
 query True

string

De API-versie die moet worden gebruikt voor de aanvraag. Ondersteunde versies zijn: 2021-10-01

Aanvraagkoptekst

Name Vereist Type Description
x-ms-max-item-count

integer (int32)

Paginagrootte
x-ms-continuation

string

vervolgtoken

Antwoorden

Name Type Description
200 OK

DeviceRegistrationState[]

Geslaagd

Kopteksten

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

ProvisioningServiceErrorDetails

Foutreactie

Kopteksten

x-ms-error-code: string

Definities

Name Description
DeviceRegistrationState

Apparaatregistratiestatus.
ProvisioningServiceErrorDetails

Bevat de eigenschappen van een fout die wordt geretourneerd door azure IoT Hub Provisioning Service.

DeviceRegistrationState

Object

Apparaatregistratiestatus.

Name Type Description
assignedHub

string

Toegewezen Azure IoT Hub.
createdDateTimeUtc

string (date-time)

Datum/tijd voor registratie maken (in UTC).
deviceId

string

Apparaat-id.
errorCode

integer (int32)

Foutcode.
errorMessage

string

Foutmelding.
etag

string

De entiteitstag die is gekoppeld aan de resource.
lastUpdatedDateTimeUtc

string (date-time)

Laatst bijgewerkte datum/tijd (in UTC).
payload

object

registrationId

string

Deze id wordt gebruikt om een apparaatregistratie van een inschrijving uniek te identificeren. Een hoofdlettergevoelige tekenreeks (maximaal 128 tekens lang) met alfanumerieke tekens plus bepaalde speciale tekens: _ -. Er zijn geen speciale tekens toegestaan aan het begin of einde.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Inschrijvingsstatus.
substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment
  • reprovisionedToInitialAssignment

Substatus voor toegewezen apparaten. Mogelijke waarden zijn : 'initialAssignment': het apparaat is voor het eerst toegewezen aan een IoT-hub, deviceDataMigrated: het apparaat is toegewezen aan een andere IoT-hub en de apparaatgegevens zijn gemigreerd van de eerder toegewezen IoT-hub. Apparaatgegevens zijn verwijderd uit de eerder toegewezen IoT-hub deviceDataReset: het apparaat is toegewezen aan een andere IoT-hub en de apparaatgegevens zijn ingevuld vanaf de initiële status die is opgeslagen in de inschrijving. Apparaatgegevens zijn verwijderd uit de eerder toegewezen IoT-hub ,'reprovisionedToInitialAssignment': Het apparaat is opnieuw ingericht voor een eerder toegewezen IoT-hub.

ProvisioningServiceErrorDetails

Object

Bevat de eigenschappen van een fout die wordt geretourneerd door azure IoT Hub Provisioning Service.

Name Type Description
errorCode

integer (int32)

info

object

message

string

timestampUtc

string (date-time)

trackingId

string