Sdílet prostřednictvím

Devices - Create Or Update Identity

  • Reference
Služba:
IoT Hub
Verze rozhraní API:
2021-04-12

Vytvoří nebo aktualizuje identitu zařízení v registru identit IoT Hub.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
id
 path True

string

Jedinečný identifikátor zařízení.
api-version
 query True

string

Verze rozhraní API.

Hlavička požadavku

Name Vyžadováno Typ Description
If-Match

string

Řetězec představující slabou značku ETag pro identitu zařízení podle RFC7232. Toto nastavení by nemělo být nastaveno při vytváření zařízení, ale může být nastaveno při aktualizaci zařízení.

Text požadavku

Name Typ Description
authentication

AuthenticationMechanism

Mechanismus ověřování používaný zařízením.
capabilities

DeviceCapabilities

Sada možností zařízení. Například jestli je toto zařízení hraničním zařízením nebo ne.
cloudToDeviceMessageCount

integer

Počet zpráv typu cloud-zařízení aktuálně zařazených do fronty, které se mají odeslat do zařízení.
connectionState enum:
  • Disconnected
  • Connected

Stav zařízení.
connectionStateUpdatedTime

string

Datum a čas poslední aktualizace stavu připojení
deviceId

string

Jedinečný identifikátor zařízení.
deviceScope

string

Rozsah zařízení. Automaticky vygenerované a neměnné pro hraniční zařízení a upravitelné v zařízeních typu list za účelem vytvoření vztahu podřízenosti a nadřazenosti
etag

string

Řetězec představující slabou značku ETag pro identitu zařízení podle RFC7232.
generationId

string

Řetězec vygenerovaný IoT Hub s rozlišováním velkých a malých písmen o délce až 128 znaků. Tato hodnota se používá k rozlišení zařízení se stejným id zařízení, když byla odstraněna a znovu vytvořena.
lastActivityTime

string

Datum a čas, kdy se zařízení naposledy připojilo, přijalo nebo odeslalo zprávu.
parentScopes

string[]

Rozsahy hraničních zařízení horní úrovně, pokud jsou k dispozici. K dispozici pouze pro hraniční zařízení.
status enum:
  • enabled
  • disabled

Stav zařízení. Pokud je stav zakázaný, zařízení se nemůže ke službě připojit.
statusReason

string

Řetězec dlouhý 128 znaků, ve kterém je uložen důvod stavu identity zařízení. Jsou povoleny všechny znaky UTF-8.
statusUpdatedTime

string

Datum a čas, kdy bylo pole stavu naposledy aktualizováno.

Odpovědi

Name Typ Description
200 OK

Device

OK.

Definice

Name Description
AuthenticationMechanism
Device
DeviceCapabilities

Stav funkcí povolených v zařízení.
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Name Typ Description
symmetricKey

SymmetricKey

Primární a sekundární klíč používaný pro ověřování na základě SAS.
type enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Typ ověřování, který se používá pro připojení ke službě.
x509Thumbprint

X509Thumbprint

Primární a sekundární kryptografické otisky x509 používané pro ověřování na základě x509.

Device

Name Typ Description
authentication

AuthenticationMechanism

Mechanismus ověřování používaný zařízením.
capabilities

DeviceCapabilities

Sada možností zařízení. Například jestli je toto zařízení hraničním zařízením nebo ne.
cloudToDeviceMessageCount

integer

Počet zpráv typu cloud-zařízení aktuálně zařazených do fronty, které se mají odeslat do zařízení.
connectionState enum:
  • Connected
  • Disconnected

Stav zařízení.
connectionStateUpdatedTime

string

Datum a čas poslední aktualizace stavu připojení
deviceId

string

Jedinečný identifikátor zařízení.
deviceScope

string

Rozsah zařízení. Automaticky vygenerované a neměnné pro hraniční zařízení a upravitelné v zařízeních typu list za účelem vytvoření vztahu podřízenosti a nadřazenosti
etag

string

Řetězec představující slabou značku ETag pro identitu zařízení podle RFC7232.
generationId

string

Řetězec vygenerovaný IoT Hub s rozlišováním velkých a malých písmen o délce až 128 znaků. Tato hodnota se používá k rozlišení zařízení se stejným id zařízení, když byla odstraněna a znovu vytvořena.
lastActivityTime

string

Datum a čas, kdy se zařízení naposledy připojilo, přijalo nebo odeslalo zprávu.
parentScopes

string[]

Rozsahy hraničních zařízení horní úrovně, pokud jsou k dispozici. K dispozici pouze pro hraniční zařízení.
status enum:
  • disabled
  • enabled

Stav zařízení. Pokud je stav zakázaný, zařízení se nemůže ke službě připojit.
statusReason

string

Řetězec dlouhý 128 znaků, ve kterém je uložen důvod stavu identity zařízení. Jsou povoleny všechny znaky UTF-8.
statusUpdatedTime

string

Datum a čas, kdy bylo pole stavu naposledy aktualizováno.

DeviceCapabilities

Stav funkcí povolených v zařízení.

Name Typ Description
iotEdge

boolean

Vlastnost, která určuje, jestli je zařízení hraničním zařízením, nebo ne.

SymmetricKey

Name Typ Description
primaryKey

string

Primární klíč zařízení kódovaný jako base64.
secondaryKey

string

Sekundární klíč zařízení kódovaný jako base64.

X509Thumbprint

Name Typ Description
primaryThumbprint

string

Primární kryptografický otisk klientského certifikátu X509.
secondaryThumbprint

string

Sekundární kryptografický otisk klientského certifikátu X509.