Modules - Create Or Update Identity
Crea o aggiorna l'identità del modulo per un dispositivo nel hub IoT. L'id modulo e generationId non possono essere aggiornati dall'utente.
PUT https://fully-qualified-iothubname.azure-devices.net/devices/{id}/modules/{mid}?api-version=2021-04-12
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
id
|
path | True |
string |
Identificatore univoco del dispositivo. |
mid
|
path | True |
string |
Identificatore univoco del modulo. |
api-version
|
query | True |
string |
Versione dell'API. |
Intestazione della richiesta
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
If-Match |
string |
Stringa che rappresenta un ETag debole per il modulo, in base RFC7232. Questa impostazione non deve essere impostata durante la creazione di un modulo, ma può essere impostata durante l'aggiornamento di un modulo. |
Corpo della richiesta
Nome | Tipo | Descrizione |
---|---|---|
authentication |
Meccanismo di autenticazione usato dal modulo per la connessione al servizio e all'hub perimetrale. |
|
cloudToDeviceMessageCount |
integer |
Numero di messaggi da cloud a modulo attualmente in coda da inviare al modulo. |
connectionState |
enum:
|
Stato di connessione del dispositivo. |
connectionStateUpdatedTime |
string |
Data e ora dell'ultimo aggiornamento dello stato della connessione. |
deviceId |
string |
Identificatore univoco del dispositivo. |
etag |
string |
Stringa che rappresenta un ETag debole per l'identità del modulo, in base RFC7232. |
generationId |
string |
Stringa con distinzione tra maiuscole e minuscole generata hub IoT fino a 128 caratteri. Questo valore viene usato per distinguere i moduli con lo stesso moduleId, quando sono stati eliminati e ricreati. |
lastActivityTime |
string |
Data e ora dell'ultima connessione, ricezione o invio di un messaggio. |
managedBy |
string |
Identifica chi gestisce questo modulo. Ad esempio, questo valore è "IotEdge" se il runtime perimetrale è proprietario di questo modulo. |
moduleId |
string |
Identificatore univoco del modulo. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
OK. |
|
201 Created |
Creazione riuscita. |
Definizioni
Nome | Descrizione |
---|---|
Authentication |
|
Module |
Identità del modulo in un dispositivo. |
Symmetric |
|
X509Thumbprint |
AuthenticationMechanism
Nome | Tipo | Descrizione |
---|---|---|
symmetricKey |
Chiavi primarie e secondarie usate per l'autenticazione basata su firma di accesso condiviso. |
|
type |
enum:
|
Tipo di autenticazione utilizzato per connettersi al servizio. |
x509Thumbprint |
Identificazioni personali x509 primarie e secondarie usate per l'autenticazione basata su x509. |
Module
Identità del modulo in un dispositivo.
Nome | Tipo | Descrizione |
---|---|---|
authentication |
Meccanismo di autenticazione usato dal modulo per la connessione al servizio e all'hub perimetrale. |
|
cloudToDeviceMessageCount |
integer |
Numero di messaggi da cloud a modulo attualmente in coda da inviare al modulo. |
connectionState |
enum:
|
Stato di connessione del dispositivo. |
connectionStateUpdatedTime |
string |
Data e ora dell'ultimo aggiornamento dello stato della connessione. |
deviceId |
string |
Identificatore univoco del dispositivo. |
etag |
string |
Stringa che rappresenta un ETag debole per l'identità del modulo, in base RFC7232. |
generationId |
string |
Stringa con distinzione tra maiuscole e minuscole generata hub IoT fino a 128 caratteri. Questo valore viene usato per distinguere i moduli con lo stesso moduleId, quando sono stati eliminati e ricreati. |
lastActivityTime |
string |
Data e ora dell'ultima connessione, ricezione o invio di un messaggio. |
managedBy |
string |
Identifica chi gestisce questo modulo. Ad esempio, questo valore è "IotEdge" se il runtime perimetrale è proprietario di questo modulo. |
moduleId |
string |
Identificatore univoco del modulo. |
SymmetricKey
Nome | Tipo | Descrizione |
---|---|---|
primaryKey |
string |
Chiave primaria con codifica Base64 del dispositivo. |
secondaryKey |
string |
Chiave secondaria con codifica Base64 del dispositivo. |
X509Thumbprint
Nome | Tipo | Descrizione |
---|---|---|
primaryThumbprint |
string |
Identificazione personale primaria del certificato client X509. |
secondaryThumbprint |
string |
Identificazione personale secondaria del certificato client X509. |