Modules - Create Or Update Identity

Serviço:

IoT Hub

Versão da API:

2021-04-12

Cria ou atualiza a identidade do módulo para um dispositivo no Hub IoT. O moduleId e generationId não podem ser atualizados pelo utilizador.

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

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
If-Match		string	A cadeia que representa uma ETag fraca para o módulo, de acordo com RFC7232. Isto não deve ser definido ao criar um módulo, mas pode ser definido ao atualizar um módulo.

Corpo do Pedido

Name	Tipo	Description
authentication	AuthenticationMechanism	O mecanismo de autenticação utilizado pelo módulo ao ligar ao serviço e ao hub edge.
cloudToDeviceMessageCount	integer	O número de mensagens da cloud para o módulo atualmente em fila para serem enviadas para o módulo.
connectionState	enum: Disconnected Connected	O estado de ligação do dispositivo.
connectionStateUpdatedTime	string	A data e hora em que o estado da ligação foi atualizado pela última vez.
deviceId	string	O identificador exclusivo do dispositivo.
etag	string	A cadeia que representa uma ETag fraca para a identidade do módulo, de acordo com RFC7232.
generationId	string	A cadeia Hub IoT gerada, sensível às maiúsculas e minúsculas, com até 128 carateres de comprimento. Este valor é utilizado para distinguir módulos com o mesmo moduleId, quando foram eliminados e recriados.
lastActivityTime	string	A data e hora em que o dispositivo foi ligado pela última vez, recebeu ou enviou uma mensagem.
managedBy	string	Identifica quem gere este módulo. Por exemplo, este valor é "IotEdge" se o runtime edge for proprietário deste módulo.
moduleId	string	O identificador exclusivo do módulo.

Respostas

Name	Tipo	Description
200 OK	Module	OK.
201 Created	Module	Criado.

Definições

Name	Description
AuthenticationMechanism
Module	A identidade do módulo num dispositivo.
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Name	Tipo	Description
symmetricKey	SymmetricKey	As chaves primárias e secundárias utilizadas para a autenticação baseada em SAS.
type	enum: certificateAuthority none sas selfSigned	O tipo de autenticação utilizado para ligar ao serviço.
x509Thumbprint	X509Thumbprint	Os thumbprints x509 primários e secundários utilizados para autenticação baseada em x509.

Module

A identidade do módulo num dispositivo.

Name	Tipo	Description
authentication	AuthenticationMechanism	O mecanismo de autenticação utilizado pelo módulo ao ligar ao serviço e ao hub edge.
cloudToDeviceMessageCount	integer	O número de mensagens da cloud para o módulo atualmente em fila para serem enviadas para o módulo.
connectionState	enum: Connected Disconnected	O estado de ligação do dispositivo.
connectionStateUpdatedTime	string	A data e hora em que o estado da ligação foi atualizado pela última vez.
deviceId	string	O identificador exclusivo do dispositivo.
etag	string	A cadeia que representa uma ETag fraca para a identidade do módulo, de acordo com RFC7232.
generationId	string	A cadeia Hub IoT gerada, sensível às maiúsculas e minúsculas, com até 128 carateres de comprimento. Este valor é utilizado para distinguir módulos com o mesmo moduleId, quando foram eliminados e recriados.
lastActivityTime	string	A data e hora em que o dispositivo foi ligado pela última vez, recebeu ou enviou uma mensagem.
managedBy	string	Identifica quem gere este módulo. Por exemplo, este valor é "IotEdge" se o runtime edge for proprietário deste módulo.
moduleId	string	O identificador exclusivo do módulo.

SymmetricKey

Name	Tipo	Description
primaryKey	string	A chave primária codificada em base64 do dispositivo.
secondaryKey	string	A chave secundária codificada base64 do dispositivo.

X509Thumbprint

Name	Tipo	Description
primaryThumbprint	string	O thumbprint primário do certificado de cliente X509.
secondaryThumbprint	string	O thumbprint secundário do certificado de cliente X509.