Devices - Create Or Update Identity

Servizio:

IoT Hub

Versione API:

2021-04-12

Crea o aggiorna l'identità di un dispositivo nel registro delle identità dell'hub IoT.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
id	path	True	string	Identificatore univoco del dispositivo.
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 l'identità del dispositivo, in base RFC7232. Questa impostazione non deve essere impostata durante la creazione di un dispositivo, ma può essere impostata durante l'aggiornamento di un dispositivo.

Corpo della richiesta

Nome	Tipo	Descrizione
authentication	AuthenticationMechanism	Meccanismo di autenticazione usato dal dispositivo.
capabilities	DeviceCapabilities	Set di funzionalità del dispositivo. Ad esempio, se questo dispositivo è un dispositivo perimetrale o meno.
cloudToDeviceMessageCount	integer (int32)	Numero di messaggi da cloud a dispositivo attualmente in coda da inviare al dispositivo.
connectionState	enum: Disconnected Connected	Stato del dispositivo.
connectionStateUpdatedTime	string (date-time)	Data e ora dell'ultimo aggiornamento dello stato della connessione.
deviceId	string	Identificatore univoco del dispositivo.
deviceScope	string	Ambito del dispositivo. Generato automaticamente e non modificabile per i dispositivi perimetrali e modificabile nei dispositivi foglia per creare una relazione figlio/padre.
etag	string	Stringa che rappresenta un ETag debole per l'identità del dispositivo, in base RFC7232.
generationId	string	Stringa con distinzione tra maiuscole e minuscole generata dall'hub IoT fino a 128 caratteri. Questo valore viene usato per distinguere i dispositivi con lo stesso deviceId, quando sono stati eliminati e ricreati.
lastActivityTime	string (date-time)	Data e ora dell'ultima connessione del dispositivo, ricezione o invio di un messaggio.
parentScopes	string[]	Ambiti dei dispositivi perimetrali di livello superiore, se applicabile. Disponibile solo per i dispositivi perimetrali.
status	enum: enabled disabled	Stato del dispositivo. Se lo stato è disabilitato, un dispositivo non può connettersi al servizio.
statusReason	string	Stringa lunga 128 caratteri che archivia il motivo dello stato dell'identità del dispositivo. Sono consentiti tutti i caratteri UTF-8.
statusUpdatedTime	string (date-time)	Data e ora dell'ultimo aggiornamento del campo di stato.

Risposte

Nome	Tipo	Descrizione
200 OK	Device	OK.

Definizioni

Nome	Descrizione
AuthenticationMechanism
Device
DeviceCapabilities	Stato delle funzionalità abilitate nel dispositivo.
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Object

Nome	Tipo	Descrizione
symmetricKey	SymmetricKey	Chiavi primarie e secondarie usate per l'autenticazione basata su firma di accesso condiviso.
type	enum: certificateAuthority none sas selfSigned	Tipo di autenticazione utilizzato per connettersi al servizio.
x509Thumbprint	X509Thumbprint	Identificazioni personali x509 primarie e secondarie usate per l'autenticazione basata su x509.

Device

Object

Nome	Tipo	Descrizione
authentication	AuthenticationMechanism	Meccanismo di autenticazione usato dal dispositivo.
capabilities	DeviceCapabilities	Set di funzionalità del dispositivo. Ad esempio, se questo dispositivo è un dispositivo perimetrale o meno.
cloudToDeviceMessageCount	integer (int32)	Numero di messaggi da cloud a dispositivo attualmente in coda da inviare al dispositivo.
connectionState	enum: Connected Disconnected	Stato del dispositivo.
connectionStateUpdatedTime	string (date-time)	Data e ora dell'ultimo aggiornamento dello stato della connessione.
deviceId	string	Identificatore univoco del dispositivo.
deviceScope	string	Ambito del dispositivo. Generato automaticamente e non modificabile per i dispositivi perimetrali e modificabile nei dispositivi foglia per creare una relazione figlio/padre.
etag	string	Stringa che rappresenta un ETag debole per l'identità del dispositivo, in base RFC7232.
generationId	string	Stringa con distinzione tra maiuscole e minuscole generata dall'hub IoT fino a 128 caratteri. Questo valore viene usato per distinguere i dispositivi con lo stesso deviceId, quando sono stati eliminati e ricreati.
lastActivityTime	string (date-time)	Data e ora dell'ultima connessione del dispositivo, ricezione o invio di un messaggio.
parentScopes	string[]	Ambiti dei dispositivi perimetrali di livello superiore, se applicabile. Disponibile solo per i dispositivi perimetrali.
status	enum: disabled enabled	Stato del dispositivo. Se lo stato è disabilitato, un dispositivo non può connettersi al servizio.
statusReason	string	Stringa lunga 128 caratteri che archivia il motivo dello stato dell'identità del dispositivo. Sono consentiti tutti i caratteri UTF-8.
statusUpdatedTime	string (date-time)	Data e ora dell'ultimo aggiornamento del campo di stato.

DeviceCapabilities

Object

Stato delle funzionalità abilitate nel dispositivo.

Nome	Tipo	Descrizione
iotEdge	boolean	Proprietà che determina se il dispositivo è un dispositivo perimetrale o meno.

SymmetricKey

Object

Nome	Tipo	Descrizione
primaryKey	string	Chiave primaria con codifica Base64 del dispositivo.
secondaryKey	string	Chiave secondaria con codifica Base64 del dispositivo.

X509Thumbprint

Object

Nome	Tipo	Descrizione
primaryThumbprint	string	Identificazione personale primaria del certificato client X509.
secondaryThumbprint	string	Identificazione personale secondaria del certificato client X509.