Modules - Create Or Update Identity
Cria ou atualiza a identidade do módulo para um dispositivo no Hub IoT. A moduleId e a generationId não podem ser atualizadas pelo usuário.
PUT https://fully-qualified-iothubname.azure-devices.net/devices/{id}/modules/{mid}?api-version=2021-04-12Parâ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. |
Cabeçalho da solicitação
| Nome | Obrigatório | Tipo | Description |
|---|---|---|---|
| If-Match |
string |
A cadeia de caracteres que representa uma ETag fraca para o módulo, de acordo com RFC7232. Isso não deve ser definido ao criar um módulo, mas pode ser definido ao atualizar um módulo. |
Corpo da solicitação
| Nome | Tipo | Description |
|---|---|---|
| authentication |
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 da nuvem para o módulo atualmente na fila a serem enviadas para o módulo. |
| connectionState |
enum:
|
O estado da 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 uma ETag fraca para a identidade do módulo, de acordo com RFC7232. |
| generationId |
string |
A cadeia de caracteres com diferenciação de maiúsculas e minúsculas gerada pelo Hub IoT com até 128 caracteres. Esse valor é usado para distinguir módulos com a mesma moduleId, quando eles foram excluídos e recriados. |
| lastActivityTime |
string (date-time) |
A data e a hora em que o dispositivo se conectou pela última vez, recebeu ou enviou uma mensagem. |
| managedBy |
string |
Identifica quem gerencia este módulo. Por exemplo, esse valor será "IotEdge" se o runtime de borda possuir este módulo. |
| moduleId |
string |
O identificador exclusivo do módulo. |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK |
OKEY. |
|
| 201 Created |
Criado. |
Definições
| Nome | Description |
|---|---|
|
Authentication |
|
| Module |
A identidade do módulo em um dispositivo. |
|
Symmetric |
|
| X509Thumbprint |
AuthenticationMechanism
| Nome | Tipo | Description |
|---|---|---|
| symmetricKey |
As chaves primárias e secundárias usadas para autenticação baseada em SAS. |
|
| type |
enum:
|
O tipo de autenticação usado para se conectar ao serviço. |
| 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 |
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 da nuvem para o módulo atualmente na fila a serem enviadas para o módulo. |
| connectionState |
enum:
|
O estado da 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 uma ETag fraca para a identidade do módulo, de acordo com RFC7232. |
| generationId |
string |
A cadeia de caracteres com diferenciação de maiúsculas e minúsculas gerada pelo Hub IoT com até 128 caracteres. Esse valor é usado para distinguir módulos com a mesma moduleId, quando eles foram excluídos e recriados. |
| lastActivityTime |
string (date-time) |
A data e a hora em que o dispositivo se conectou pela última vez, recebeu ou enviou uma mensagem. |
| managedBy |
string |
Identifica quem gerencia este módulo. Por exemplo, esse valor será "IotEdge" se o runtime de borda 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. |