Partilhar via

Devices - Get Identity

Serviço:
IoT Hub
Versão da API:
2021-04-12

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

GET https://fully-qualified-iothubname.azure-devices.net/devices/{id}?api-version=2021-04-12

Parâmetros do URI

Name Em Necessário Tipo Description
id
 path True

string

O identificador exclusivo do dispositivo.
api-version
 query True

string

Versão da Api.

Respostas

Name Tipo Description
200 OK

Device

OK.

Definições

Name Description
AuthenticationMechanism
Device
DeviceCapabilities

O status dos recursos habilitados no dispositivo.
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Object
Name Tipo Description
symmetricKey

SymmetricKey

As chaves primária e secundária usadas para autenticação baseada em SAS.
type enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

O tipo de autenticação usado para se conectar ao serviço.
x509Thumbprint

X509Thumbprint

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

Device

Object
Name Tipo Description
authentication

AuthenticationMechanism

O mecanismo de autenticação usado pelo dispositivo.
capabilities

DeviceCapabilities

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

integer (int32)

O número de mensagens da nuvem para o dispositivo atualmente na fila para serem enviadas ao dispositivo.
connectionState enum:
  • Connected
  • Disconnected

O estado do dispositivo.
connectionStateUpdatedTime

string (date-time)

A data e a hora em que o estado da conexão foi atualizado pela última vez.
deviceId

string

O identificador exclusivo do dispositivo.
deviceScope

string

O escopo do dispositivo. Gerado automaticamente e imutável para dispositivos de borda e modificável em dispositivos folha para criar relação filho/pai.
etag

string

A cadeia de caracteres que representa um ETag fraco para a identidade do dispositivo, conforme RFC7232.
generationId

string

A cadeia de caracteres gerada pelo Hub IoT, sensível a maiúsculas e minúsculas, tem até 128 caracteres. Esse valor é usado para distinguir dispositivos com o mesmo deviceId, quando eles foram excluídos e recriados.
lastActivityTime

string (date-time)

A data e a última vez que o dispositivo se conectou, recebeu ou enviou uma mensagem pela última vez.
parentScopes

string[]

Os escopos dos dispositivos de borda de nível superior, se aplicável. Disponível apenas para dispositivos de borda.
status enum:
  • disabled
  • enabled

O status do dispositivo. Se o status estiver desativado, um dispositivo não poderá se conectar ao serviço.
statusReason

string

A cadeia de caracteres de 128 caracteres que armazena o motivo do status de identidade do dispositivo. Todos os caracteres UTF-8 são permitidos.
statusUpdatedTime

string (date-time)

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

DeviceCapabilities

Object

O status dos recursos habilitados no dispositivo.

Name Tipo Description
iotEdge

boolean

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

SymmetricKey

Object
Name Tipo Description
primaryKey

string

A chave primária codificada base64 do dispositivo.
secondaryKey

string

A chave secundária codificada base64 do dispositivo.

X509Thumbprint

Object
Name Tipo Description
primaryThumbprint

string

A impressão digital primária do certificado do cliente X509.
secondaryThumbprint

string

A impressão digital secundária do certificado do cliente X509.