Device Registration State - Query

Obtém o estado de registo dos dispositivos neste Grupo de Inscrição.

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

Parâmetros do URI

Name In Required Type Description
id
path True
  • string

Identificação do grupo de inscrições.

api-version
query True
  • string

A versão API a utilizar para o pedido. As versões suportadas incluem: 2021-06-01

Cabeçalho do Pedido

Name Required Type Description
x-ms-max-item-count
  • integer
int32

tamanho de página

x-ms-continuation
  • string

token de continuação

Respostas

Name Type Description
200 OK

Com êxito

Headers

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

Resposta de erro

Definições

DeviceRegistrationState

Estado de registo do dispositivo.

ProvisioningServiceErrorDetails

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

DeviceRegistrationState

Estado de registo do dispositivo.

Name Type Description
assignedHub
  • string

Designado Hub IoT do Azure.

createdDateTimeUtc
  • string

As inscrições criam a data (na UTC).

deviceId
  • string

Identificação do dispositivo.

errorCode
  • integer

Código de erro.

errorMessage
  • string

Mensagem de erro.

etag
  • string

A etiqueta de entidade associada ao recurso.

lastUpdatedDateTimeUtc
  • string

Última data atualizada (em UTC).

payload
  • object

Carga útil de atribuição personalizada devolvida do webhook para o dispositivo.

registrationId
  • string

O ID de registo é alfanumérico, minúsculo, e pode conter hífenes.

status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Estado de inscrição.

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 centro IoT diferente e os dados do dispositivo foram migrados do hub IoT anteriormente atribuído. Os dados do dispositivo foram removidos do hub IoT anteriormente atribuído, 'deviceDataReset': O dispositivo foi atribuído a um outro hub IoT e os dados do dispositivo foram preenchidos a partir do estado inicial armazenado na inscrição. Os dados do dispositivo foram removidos do hub IoT anteriormente atribuído, "reprovisionedToInitialAssignment": O dispositivo foi re-aprovisionado para um hub IoT previamente atribuído.

ProvisioningServiceErrorDetails

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

Name Type Description
errorCode
  • integer
info
  • object
message
  • string
timestampUtc
  • string
trackingId
  • string