Device Registration State - Query

  • Referencia
Service:
IoT Hub Device Provisioning Service
API Version:
2021-06-01

Obtiene el estado de registro de los dispositivos en este enrollmentGroup.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
id
 path True

string

Identificador de grupo de inscripción.
api-version
 query True

string

La versión de API que se usará para la solicitud. Las versiones admitidas incluyen: 2021-06-01

Encabezado de la solicitud

Nombre Requerido Tipo Description
x-ms-max-item-count

integer

int32

pageSize
x-ms-continuation

string

token de continuación

Respuestas

Nombre Tipo Description
200 OK

DeviceRegistrationState[]

Correcto

Headers

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

ProvisioningServiceErrorDetails

Respuesta de error

Definiciones

Nombre Description
DeviceRegistrationState

Estado de registro del dispositivo.
ProvisioningServiceErrorDetails

Contiene las propiedades de un error devuelto por el servicio de aprovisionamiento de Azure IoT Hub.

DeviceRegistrationState

Estado de registro del dispositivo.

Nombre Tipo Description
assignedHub

string

Azure IoT Hub asignados.
createdDateTimeUtc

string

Fecha y hora de creación del registro (en UTC).
deviceId

string

Id. de dispositivo.
errorCode

integer

Código de error.
errorMessage

string

Mensaje de error.
etag

string

Etiqueta de entidad asociada al recurso.
lastUpdatedDateTimeUtc

string

Hora de fecha y hora de la última actualización (en UTC).
payload

object

Carga de asignación personalizada devuelta desde el webhook al dispositivo.
registrationId

string

El identificador de registro está formado por caracteres alfanuméricos y en minúscula, y puede contener guiones.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Estado de inscripción.
substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment
  • reprovisionedToInitialAssignment

Subestado para dispositivos "Asignados". Los valores posibles incluyen : "initialAssignment": el dispositivo se ha asignado a un centro de IoT por primera vez, "deviceDataMigrated": el dispositivo se ha asignado a otro centro de IoT y sus datos de dispositivo se migraron desde el centro de IoT asignado anteriormente. Los datos del dispositivo se quitaron del centro de IoT asignado anteriormente, "deviceDataReset": el dispositivo se asignó a otro centro de IoT y sus datos del dispositivo se rellenaron a partir del estado inicial almacenado en la inscripción. Los datos del dispositivo se quitaron del centro de IoT asignado anteriormente, "reprovisionedToInitialAssignment": el dispositivo se ha vuelto a aprovisionar en un centro de IoT asignado previamente.

ProvisioningServiceErrorDetails

Contiene las propiedades de un error devuelto por el servicio de aprovisionamiento de Azure IoT Hub.

Nombre Tipo Description
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string