Partilhar via


Modules - Get Identity

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 do URI

Name Em Necessá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

Name Tipo Description
200 OK

Module

OK.

Definições

Name Description
AuthenticationMechanism
Module

A identidade do módulo em um dispositivo.

SymmetricKey
X509Thumbprint

AuthenticationMechanism

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.

Module

A identidade do módulo em um dispositivo.

Name 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 (int32)

O número de mensagens de nuvem para módulo atualmente enfileiradas para serem enviadas ao módulo.

connectionState enum:
  • Connected
  • Disconnected

O estado de conexão 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.

etag

string

A cadeia de caracteres que representa um ETag fraco para a identidade do módulo, conforme RFC7232.

generationId

string

O Hub IoT gerou uma cadeia de caracteres que diferencia maiúsculas de minúsculas com até 128 caracteres. Esse valor é usado para distinguir módulos com o mesmo moduleId, quando eles foram excluídos e recriados.

lastActivityTime

string (date-time)

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 é "IotEdge" se o tempo de execução da borda possuir esse módulo.

moduleId

string

O identificador exclusivo do módulo.

SymmetricKey

Name Tipo Description
primaryKey

string

A chave primária codificada base64 do dispositivo.

secondaryKey

string

A chave secundária codificada base64 do dispositivo.

X509Thumbprint

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.