Compartilhar via

Modules - Get Identity

  • Referência
Serviço:
IoT Hub
Versão da API:
2021-04-12

Obtém uma identidade de módulo no dispositivo.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
id
 path True

string

O identificador exclusivo do dispositivo.
mid
 path True

string

O identificador exclusivo do módulo.
api-version
 query True

string

Versão da API.

Respostas

Nome Tipo Description
200 OK

Module

OK.

Definições

Nome Description
AuthenticationMechanism
Module

A identidade do módulo em um dispositivo.
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Nome Tipo Description
symmetricKey

SymmetricKey

As chaves primárias e secundárias 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.

Module

A identidade do módulo em um dispositivo.

Nome Tipo Description
authentication

AuthenticationMechanism

O mecanismo de autenticação usado pelo módulo ao se conectar ao serviço e ao hub de borda.
cloudToDeviceMessageCount

integer

O número de mensagens da nuvem para o módulo atualmente na fila a serem enviadas para o módulo.
connectionState enum:
  • Connected
  • Disconnected

O estado de conexão do dispositivo.
connectionStateUpdatedTime

string

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

string

O identificador exclusivo do dispositivo.
etag

string

A cadeia de caracteres que representa uma ETag fraca para a identidade do módulo, de acordo com RFC7232.
generationId

string

O Hub IoT cadeia de caracteres com diferenciação de maiúsculas e minúsculas de até 128 caracteres. Esse valor é usado para distinguir módulos com a mesma moduleId, quando eles foram excluídos e recriados.
lastActivityTime

string

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

string

Identifica quem gerencia este módulo. Por exemplo, esse valor será "IotEdge" se o runtime do Edge possuir este módulo.
moduleId

string

O identificador exclusivo do módulo.

SymmetricKey

Nome Tipo Description
primaryKey

string

A chave primária codificada em base64 do dispositivo.
secondaryKey

string

A chave secundária codificada em base64 do dispositivo.

X509Thumbprint

Nome 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.