Devices - Get Identity

Obtém um dispositivo do registo de identidade do IoT Hub.

GET https://fully-qualified-iothubname.azure-devices.net/devices/{id}?api-version=2020-05-31-preview

Parâmetros do URI

Name In Required Type Description
id
path True
  • string

O identificador único do dispositivo.

api-version
query True
  • string

Versão da Api.

Respostas

Name Type Description
200 OK

OK.

Definições

AuthenticationMechanism
Device
DeviceCapabilities

O estado das capacidades ativadas no dispositivo.

SymmetricKey
X509Thumbprint

AuthenticationMechanism

Name Type Description
symmetricKey

As teclas primárias e secundárias utilizadas para a autenticação baseada em SAS.

type enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

O tipo de autenticação utilizada para ligar ao serviço.

x509Thumbprint

As impressões digitais x509 primárias e secundárias utilizadas para a autenticação baseada em x509.

Device

Name Type Description
authentication

O mecanismo de autenticação utilizado pelo aparelho.

capabilities

O conjunto de capacidades do dispositivo. Por exemplo, se este dispositivo for um dispositivo de borda ou não.

cloudToDeviceMessageCount
  • integer

O número de mensagens cloud-to-device atualmente em fila para ser enviado para o dispositivo.

connectionState enum:
  • Connected
  • Disconnected

O estado do dispositivo.

connectionStateUpdatedTime
  • string

A data e a hora da ligação foi atualizada pela última vez.

deviceId
  • string

O identificador único do dispositivo.

deviceScope
  • string

O âmbito do dispositivo. Auto gerado e imutável para dispositivos de borda e modificável em dispositivos de folha para criar relação criança/pai.

etag
  • string

A cadeia que representa um ETag fraco para a identidade do dispositivo, de acordo com o RFC7232.

generationId
  • string

A corda ioT hub gerada, sensível a casos até 128 caracteres de comprimento. Este valor é utilizado para distinguir os dispositivos com o mesmo dispositivoId, quando estes foram eliminados e recriados.

lastActivityTime
  • string

A data e a última vez que o dispositivo ligou, recebeu ou enviou uma mensagem.

status enum:
  • disabled
  • enabled

O estado do dispositivo. Se o estado for desativado, um dispositivo não pode ligar-se ao serviço.

statusReason
  • string

A cadeia de 128 caracteres que armazena a razão para o estado de identidade do dispositivo. Todos os caracteres UTF-8 são permitidos.

statusUpdatedTime
  • string

A data e a hora em que o campo de estado foi atualizado pela última vez.

DeviceCapabilities

O estado das capacidades ativadas no dispositivo.

Name Type Description
iotEdge
  • boolean

A propriedade que determina se o dispositivo é um dispositivo de borda ou não.

SymmetricKey

Name Type Description
primaryKey
  • string

A chave primária codificada da base64 do dispositivo.

secondaryKey
  • string

A chave secundária codificada da base64 do dispositivo.

X509Thumbprint

Name Type Description
primaryThumbprint
  • string

O certificado de cliente X509 é a impressão digital primária do certificado de cliente.

secondaryThumbprint
  • string

O certificado de cliente X509, impressão digital secundária.