Megosztás a következőn keresztül:


Twin class

Az ikereszköz egy Azure IoT Hub által tárolt eszköz állapotát leíró dokumentum, amely akkor is elérhető, ha az eszköz offline állapotban van. 3 részből áll:

  • Címkék: kulcs/érték párok csak a szolgáltatásoldalról érhetők el
  • Kívánt tulajdonságok: egy szolgáltatás által frissített és az eszköz által fogadott tulajdonságok
  • Jelentett tulajdonságok: az eszköz frissítette és a szolgáltatás fogadta.

Vegye figyelembe, hogy bár lehetséges, a kívánt és a jelentett tulajdonságoknak nem kell egyezniük, és hogy a két gyűjtemény szinkronizálásának logikája, ha szükséges, az SDK felhasználójára marad.

További információ: Device Twinsismertetése.

A Twin egy adott eszközhöz való beszerzésének ajánlott módja a getTwin(string, HttpResponseCallback<Twin>) módszer használata.

Konstruktorok

Twin(string | DeviceIdentity, Registry)

Új Twinpéldányosít. Az új Twin objektum lekérésének ajánlott módja a getTwin(string, HttpResponseCallback<Twin>) metódus használata.

Tulajdonságok

deviceId

Az ikerpéldányhoz társított eszközidentitás egyedi azonosítója, mivel az az eszközidentitás-beállításjegyzékben található.

etag

Az optimista egyidejűségben használt címke az ikereszköz több párhuzamos kiadásának elkerülése érdekében.

modelId

Az ikerpéldányhoz társított eszközidentitás modellazonosítója, mivel az az eszközidentitás-beállításjegyzékben található.

moduleId

Az ikerpéldányhoz társított modul modulazonosítója, mivel az az eszközidentitás-beállításjegyzékben található.

properties

A kívánt és jelentett tulajdonságok dictionnaries (illetve a properties.desired és properties.reported).

tags

Olyan kulcs-/érték párok gyűjteménye, amelyek csak a szolgáltatás oldalán érhetők el, és adott eszközök megkereséséhez használhatók lekérdezésekben.

Metódusok

get()
get(IncomingMessageCallback<Twin>)

Lekéri az ikereszköz legújabb verzióját az IoT Hub szolgáltatásból.

toJSON()
update(any)
update(any, IncomingMessageCallback<Twin>)

Frissítse az ikereszközt argumentumként megadott javítással.

Konstruktor adatai

Twin(string | DeviceIdentity, Registry)

Új Twinpéldányosít. Az új Twin objektum lekérésének ajánlott módja a getTwin(string, HttpResponseCallback<Twin>) metódus használata.

new Twin(device: string | DeviceIdentity, registryClient: Registry)

Paraméterek

device

string | DeviceIdentity

Eszközazonosító sztring vagy az eszközt leíró objektum. Ha egy objektumnak deviceId tulajdonságot kell tartalmaznia.

registryClient
Registry

A REST API-hívások végrehajtásához használt HTTP-beállításjegyzék-ügyfél.

Tulajdonság adatai

deviceId

Az ikerpéldányhoz társított eszközidentitás egyedi azonosítója, mivel az az eszközidentitás-beállításjegyzékben található.

deviceId: string

Tulajdonság értéke

string

etag

Az optimista egyidejűségben használt címke az ikereszköz több párhuzamos kiadásának elkerülése érdekében.

etag: string

Tulajdonság értéke

string

modelId

Az ikerpéldányhoz társított eszközidentitás modellazonosítója, mivel az az eszközidentitás-beállításjegyzékben található.

modelId?: string

Tulajdonság értéke

string

moduleId

Az ikerpéldányhoz társított modul modulazonosítója, mivel az az eszközidentitás-beállításjegyzékben található.

moduleId?: string

Tulajdonság értéke

string

properties

A kívánt és jelentett tulajdonságok dictionnaries (illetve a properties.desired és properties.reported).

properties: { desired: {[key: string]: any}, reported: {[key: string]: any} }

Tulajdonság értéke

{ desired: {[key: string]: any}, reported: {[key: string]: any} }

tags

Olyan kulcs-/érték párok gyűjteménye, amelyek csak a szolgáltatás oldalán érhetők el, és adott eszközök megkereséséhez használhatók lekérdezésekben.

tags: {[key: string]: string}

Tulajdonság értéke

{[key: string]: string}

Metódus adatai

get()

function get(): Promise<ResultWithIncomingMessage<Twin>>

Válaszok

Promise<ResultWithIncomingMessage<Twin>>

get(IncomingMessageCallback<Twin>)

Lekéri az ikereszköz legújabb verzióját az IoT Hub szolgáltatásból.

function get(done?: IncomingMessageCallback<Twin>)

Paraméterek

done

IncomingMessageCallback<Twin>

A művelet befejezésekor hívandó opcionális függvény. done három argumentummal lesz meghívva: hibaobjektum (lehet null), egy ikereszköz- objektum, amely a létrehozott eszközidentitást jelöli, valamint egy átvitelspecifikus válaszobjektum, amely hasznos naplózáshoz vagy hibakereséshez.

toJSON()

function toJSON(): object

Válaszok

object

update(any)

function update(patch: any): Promise<ResultWithIncomingMessage<Twin>>

Paraméterek

patch

any

Válaszok

Promise<ResultWithIncomingMessage<Twin>>

update(any, IncomingMessageCallback<Twin>)

Frissítse az ikereszközt argumentumként megadott javítással.

function update(patch: any, done?: IncomingMessageCallback<Twin>)

Paraméterek

patch

any

Az ikereszközre alkalmazandó új értékeket tartalmazó objektum.

done

IncomingMessageCallback<Twin>

A művelet befejezésekor hívandó opcionális függvény. done három argumentummal lesz meghívva: hibaobjektum (lehet null), egy ikereszköz- objektum, amely a létrehozott eszközidentitást jelöli, valamint egy átvitelspecifikus válaszobjektum, amely hasznos naplózáshoz vagy hibakereséshez.