Compartilhar via

Device Registration State - Query

  • Referência
Serviço:
IoT Hub Device Provisioning Service
Versão da API:
2021-10-01

Obtém o estado de registro de dispositivos neste enrollmentGroup.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
id
 path True

string

ID do grupo de registro.
api-version
 query True

string

A versão da API a ser usada para a solicitação. As versões com suporte incluem: 2021-10-01

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
x-ms-max-item-count

integer

int32

pageSize
x-ms-continuation

string

token de continuação

Respostas

Nome Tipo Description
200 OK

DeviceRegistrationState[]

Êxito

Cabeçalhos

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

ProvisioningServiceErrorDetails

Resposta de erro

Cabeçalhos

x-ms-error-code: string

Definições

Nome Description
DeviceRegistrationState

Estado de registro do dispositivo.
ProvisioningServiceErrorDetails

Contém as propriedades de um erro retornado pelo Serviço de Provisionamento de Hub IoT do Azure.

DeviceRegistrationState

Estado de registro do dispositivo.

Nome Tipo Description
assignedHub

string

Atribuído Hub IoT do Azure.
createdDateTimeUtc

string

Data de criação do registro (em UTC).
deviceId

string

ID do Dispositivo.
errorCode

integer

Código do erro.
errorMessage

string

Mensagem de erro.
etag

string

A marca de entidade associada ao recurso.
lastUpdatedDateTimeUtc

string

Hora da data da última atualização (em UTC).
payload

object

registrationId

string

Essa ID é usada para identificar exclusivamente um registro de dispositivo de um registro. Uma cadeia de caracteres que não diferencia maiúsculas de minúsculas (até 128 caracteres de comprimento) de caracteres alfanuméricos mais determinados caracteres especiais: . _ -. Nenhum caractere especial permitido no início ou no final.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Status de registro.
substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment
  • reprovisionedToInitialAssignment

Substatus para dispositivos 'Atribuídos'. Os valores possíveis incluem - 'initialAssignment': o dispositivo foi atribuído a um hub IoT pela primeira vez, 'deviceDataMigrated': o dispositivo foi atribuído a um hub IoT diferente e seus dados de dispositivo foram migrados do hub IoT atribuído anteriormente. Os dados do dispositivo foram removidos do hub IoT atribuído anteriormente, 'deviceDataReset': o dispositivo foi atribuído a um hub IoT diferente e seus dados de dispositivo foram preenchidos do estado inicial armazenado no registro. Os dados do dispositivo foram removidos do hub IoT atribuído anteriormente, 'reprovisionedToInitialAssignment': o dispositivo foi provisionado novamente para um hub IoT atribuído anteriormente.

ProvisioningServiceErrorDetails

Contém as propriedades de um erro retornado pelo Serviço de Provisionamento de Hub IoT do Azure.

Nome Tipo Description
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string