Devices - Create Or Update Identity

  • Referencia
Service:
IoT Hub
API Version:
2021-04-12

Létrehozza vagy frissíti egy eszköz identitását a IoT Hub identitásjegyzékében.

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

URI-paraméterek

Name In Kötelező Típus Description
id
 path True

string

Az eszköz egyedi azonosítója.
api-version
 query True

string

Az API verziója.

Kérelem fejléce

Name Kötelező Típus Description
If-Match

string

Az eszközidentitás gyenge ETag-jének megfelelő sztring, a RFC7232 szerint. Ezt nem szabad beállítani az eszköz létrehozásakor, de az eszköz frissítésekor be lehet állítani.

Kérelem törzse

Name Típus Description
authentication

AuthenticationMechanism

Az eszköz által használt hitelesítési mechanizmus.
capabilities

DeviceCapabilities

Az eszköz képességeinek halmaza. Ha például ez az eszköz egy peremeszköz, vagy sem.
cloudToDeviceMessageCount

integer

Az eszközre jelenleg várólistára helyezett, felhőből eszközre irányuló üzenetek száma.
connectionState enum:
  • Disconnected
  • Connected

Az eszköz állapota.
connectionStateUpdatedTime

string

A kapcsolat állapotának utolsó frissítésének dátuma és időpontja.
deviceId

string

Az eszköz egyedi azonosítója.
deviceScope

string

Az eszköz hatóköre. Automatikusan generált és nem módosítható a peremeszközökhöz, és módosítható a levéleszközökben a gyermek-szülő kapcsolat létrehozásához.
etag

string

Az eszközidentitás gyenge ETag-jének megfelelő sztring, a RFC7232 szerint.
generationId

string

A IoT Hub által létrehozott, legfeljebb 128 karakter hosszú, kis- és nagybetűkre érzékeny sztring. Ez az érték megkülönbözteti az azonos deviceId azonosítójú eszközöket, amikor törölték és újra létrehozták őket.
lastActivityTime

string

Az eszköz legutóbbi csatlakoztatásának, fogadásának vagy üzenetküldésének dátuma és utolsó időpontja.
parentScopes

string[]

A felső szintű peremeszközök hatókörei, ha vannak. Csak peremeszközökhöz érhető el.
status enum:
  • enabled
  • disabled

Az eszköz állapota. Ha az állapot le van tiltva, az eszköz nem tud csatlakozni a szolgáltatáshoz.
statusReason

string

Az eszközidentitás állapotának okát tároló 128 karakter hosszú sztring. Minden UTF-8 karakter megengedett.
statusUpdatedTime

string

Az állapotmező utolsó frissítésének dátuma és időpontja.

Válaszok

Name Típus Description
200 OK

Device

OK gombra.

Definíciók

Name Description
AuthenticationMechanism
Device
DeviceCapabilities

Az eszközön engedélyezett képességek állapota.
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Name Típus Description
symmetricKey

SymmetricKey

A SAS-alapú hitelesítéshez használt elsődleges és másodlagos kulcsok.
type enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

A szolgáltatáshoz való csatlakozáshoz használt hitelesítés típusa.
x509Thumbprint

X509Thumbprint

Az x509-alapú hitelesítéshez használt elsődleges és másodlagos x509 ujjlenyomatok.

Device

Name Típus Description
authentication

AuthenticationMechanism

Az eszköz által használt hitelesítési mechanizmus.
capabilities

DeviceCapabilities

Az eszköz képességeinek halmaza. Ha például ez az eszköz egy peremeszköz, vagy sem.
cloudToDeviceMessageCount

integer

Az eszközre jelenleg várólistára helyezett, felhőből eszközre irányuló üzenetek száma.
connectionState enum:
  • Connected
  • Disconnected

Az eszköz állapota.
connectionStateUpdatedTime

string

A kapcsolat állapotának utolsó frissítésének dátuma és időpontja.
deviceId

string

Az eszköz egyedi azonosítója.
deviceScope

string

Az eszköz hatóköre. Automatikusan generált és nem módosítható a peremeszközökhöz, és módosítható a levéleszközökben a gyermek-szülő kapcsolat létrehozásához.
etag

string

Az eszközidentitás gyenge ETag-jének megfelelő sztring, a RFC7232 szerint.
generationId

string

A IoT Hub által létrehozott, legfeljebb 128 karakter hosszú, kis- és nagybetűkre érzékeny sztring. Ez az érték megkülönbözteti az azonos deviceId azonosítójú eszközöket, amikor törölték és újra létrehozták őket.
lastActivityTime

string

Az eszköz legutóbbi csatlakoztatásának, fogadásának vagy üzenetküldésének dátuma és utolsó időpontja.
parentScopes

string[]

A felső szintű peremeszközök hatókörei, ha vannak. Csak peremeszközökhöz érhető el.
status enum:
  • disabled
  • enabled

Az eszköz állapota. Ha az állapot le van tiltva, az eszköz nem tud csatlakozni a szolgáltatáshoz.
statusReason

string

Az eszközidentitás állapotának okát tároló 128 karakter hosszú sztring. Minden UTF-8 karakter megengedett.
statusUpdatedTime

string

Az állapotmező utolsó frissítésének dátuma és időpontja.

DeviceCapabilities

Az eszközön engedélyezett képességek állapota.

Name Típus Description
iotEdge

boolean

Az a tulajdonság, amely meghatározza, hogy az eszköz peremeszköz-e.

SymmetricKey

Name Típus Description
primaryKey

string

Az eszköz base64 kódolású elsődleges kulcsa.
secondaryKey

string

Az eszköz base64 kódolású másodlagos kulcsa.

X509Thumbprint

Name Típus Description
primaryThumbprint

string

Az X509 ügyféltanúsítvány elsődleges ujjlenyomata.
secondaryThumbprint

string

Az X509 ügyféltanúsítvány másodlagos ujjlenyomata.