az iot hub device-twin

Feljegyzés

Ez a hivatkozás az Azure CLI azure-iot bővítményének része (2.37.0-s vagy újabb verzió). A bővítmény automatikusan telepíti az az iot hub device-twin parancs első futtatásakor. További információ a bővítményekről.

IoT-eszköz ikerkonfigurációjának kezelése.

Parancsok

Name	Description	Típus	Állapot
az iot hub device-twin list	IoT Hubon lévő ikereszközök listázása.	Bővítmény	FE
az iot hub device-twin replace	Cserélje le az ikereszköz-definíciót a cél jsonra.	Bővítmény	FE
az iot hub device-twin show	Ikereszköz-definíció lekérése.	Bővítmény	FE
az iot hub device-twin update	Frissítse az ikereszköz kívánt tulajdonságait és címkéit.	Bővítmény	FE

az iot hub device-twin list

IoT Hubon lévő ikereszközök listázása.

Ez a parancs megegyezik az iot hub lekérdezésével, és a "select * from devices" (Kiválasztás az eszközökről) lekérdezéssel az összes eszközhöz, és "select * from devices where capabilities.iotEdge = true" (a capabilities.iotEdge = true) lehetőséget a peremeszközökhöz.

az iot hub device-twin list [--auth-type {key, login}]
                            [--edge-enabled {false, true}]
                            [--hub-name]
                            [--login]
                            [--resource-group]
                            [--top]

Opcionális paraméterek

--auth-type

Azt jelzi, hogy a műveletnek automatikusan le kell-e származtatnia egy szabályzatkulcsot, vagy az aktuális Azure AD-munkamenetet kell-e használnia. Ha a hitelesítési típus bejelentkezés, és az erőforrás-állomásnév meg van adva, az erőforrás-keresés kihagyva lesz, hacsak nem szükséges. Az alapértelmezett beállítást a következővel az configure --defaults iothub-data-auth-type=<auth-type-value>konfigurálhatja: .

elfogadott értékek: key, login

alapértelmezett érték: key

--edge-enabled --ee

A peremhálózat engedélyezését jelző jelző.

elfogadott értékek: false, true

alapértelmezett érték: False

--hub-name -n

IoT Hub neve vagy állomásneve. Kötelező, ha a --login nincs megadva.

--login -l

Ez a parancs egy művelet végrehajtására jogosult entitást kapcsolati sztring támogat. Az "az login" használatával elkerülheti a munkamenet-bejelentkezést. Ha egy entitás kapcsolati sztring és név is meg van adva, a kapcsolati sztring elsőbbséget élvez. Ha a --hub-name nincs megadva, kötelező megadni.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

--top

A visszaadandó elemek maximális száma. Használja a -1-et korlátlanul.

alapértelmezett érték: 1000

Globális paraméterek

--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc

alapértelmezett érték: json

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az iot hub device-twin replace

Cserélje le az ikereszköz-definíciót a cél jsonra.

Közvetlenül bemeneti json vagy fájl elérési útja.

az iot hub device-twin replace --device-id
                               --json
                               [--auth-type {key, login}]
                               [--etag]
                               [--hub-name]
                               [--login]
                               [--resource-group]

Példák

Cserélje le az ikereszközt fájltartalomra.

az iot hub device-twin replace -d {device_id} -n {iothub_name} -j ../mydevicetwin.json

Kötelező paraméterek

--device-id -d

Céleszköz-azonosító.

--json -j

Json a meglévő ikerpéldány lecseréléséhez. Adja meg a fájl elérési útját vagy a nyers jsont.

Opcionális paraméterek

--auth-type

Azt jelzi, hogy a műveletnek automatikusan le kell-e származtatnia egy szabályzatkulcsot, vagy az aktuális Azure AD-munkamenetet kell-e használnia. Ha a hitelesítési típus bejelentkezés, és az erőforrás-állomásnév meg van adva, az erőforrás-keresés kihagyva lesz, hacsak nem szükséges. Az alapértelmezett beállítást a következővel az configure --defaults iothub-data-auth-type=<auth-type-value>konfigurálhatja: .

elfogadott értékek: key, login

alapértelmezett érték: key

--etag -e

Az erőforrás utolsó állapotának megfelelő etag vagy entitáscímke. Ha nincs megadva etag, a rendszer a "*" értéket használja.

--hub-name -n

IoT Hub neve vagy állomásneve. Kötelező, ha a --login nincs megadva.

--login -l

Ez a parancs egy művelet végrehajtására jogosult entitást kapcsolati sztring támogat. Az "az login" használatával elkerülheti a munkamenet-bejelentkezést. Ha egy entitás kapcsolati sztring és név is meg van adva, a kapcsolati sztring elsőbbséget élvez. Ha a --hub-name nincs megadva, kötelező megadni.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

Globális paraméterek

--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc

alapértelmezett érték: json

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az iot hub device-twin show

Ikereszköz-definíció lekérése.

az iot hub device-twin show --device-id
                            [--auth-type {key, login}]
                            [--hub-name]
                            [--login]
                            [--resource-group]

Kötelező paraméterek

--device-id -d

Céleszköz-azonosító.

Opcionális paraméterek

--auth-type

Azt jelzi, hogy a műveletnek automatikusan le kell-e származtatnia egy szabályzatkulcsot, vagy az aktuális Azure AD-munkamenetet kell-e használnia. Ha a hitelesítési típus bejelentkezés, és az erőforrás-állomásnév meg van adva, az erőforrás-keresés kihagyva lesz, hacsak nem szükséges. Az alapértelmezett beállítást a következővel az configure --defaults iothub-data-auth-type=<auth-type-value>konfigurálhatja: .

elfogadott értékek: key, login

alapértelmezett érték: key

--hub-name -n

IoT Hub neve vagy állomásneve. Kötelező, ha a --login nincs megadva.

--login -l

Ez a parancs egy művelet végrehajtására jogosult entitást kapcsolati sztring támogat. Az "az login" használatával elkerülheti a munkamenet-bejelentkezést. Ha egy entitás kapcsolati sztring és név is meg van adva, a kapcsolati sztring elsőbbséget élvez. Ha a --hub-name nincs megadva, kötelező megadni.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

Globális paraméterek

--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc

alapértelmezett érték: json

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az iot hub device-twin update

Frissítse az ikereszköz kívánt tulajdonságait és címkéit.

Adjon meg --desired vagy --tags argumentumokat a PATCH viselkedéséhez. Mindkét paraméter támogatja a beágyazott jsont vagy a json-tartalom fájlelérési útját. Az általános frissítési argek (azaz --set) használata a PUT viselkedését tükrözi, és elavult.

az iot hub device-twin update --device-id
                              [--add]
                              [--auth-type {key, login}]
                              [--desired]
                              [--etag]
                              [--force-string]
                              [--hub-name]
                              [--login]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--tags]

Példák

Az ikereszköz kívánt tulajdonságainak javítása.

az iot hub device-twin update -n {iothub_name} -d {device_id} --desired '{"conditions":{"temperature":{"warning":70, "critical":100}}}'

Az ikereszköz címkéinek javítása.

az iot hub device-twin update -n {iothub_name} -d {device_id} --tags '{"country": "USA"}'

Ikereszköz-címkék javítása json-fájltartalommal.

az iot hub device-twin update -n {iothub_name} -d {device_id} --tags /path/to/file

A "kritikus" kívánt tulajdonság javítása a szülő "hőmérsékletéről"

az iot hub device-twin update -n {iothub_name} -d {device_id} --desired '{"condition":{"temperature":{"critical": null}}}'

Kötelező paraméterek

--device-id -d

Céleszköz-azonosító.

Opcionális paraméterek

--add

Adjon hozzá egy objektumot az objektumok listájához egy elérési út és egy kulcsértékpár megadásával. Példa: --add property.listProperty <key=value, string or JSON string>

alapértelmezett érték: []

--auth-type

Azt jelzi, hogy a műveletnek automatikusan le kell-e származtatnia egy szabályzatkulcsot, vagy az aktuális Azure AD-munkamenetet kell-e használnia. Ha a hitelesítési típus bejelentkezés, és az erőforrás-állomásnév meg van adva, az erőforrás-keresés kihagyva lesz, hacsak nem szükséges. Az alapértelmezett beállítást a következővel az configure --defaults iothub-data-auth-type=<auth-type-value>konfigurálhatja: .

elfogadott értékek: key, login

alapértelmezett érték: key

--desired

Iker kívánt tulajdonságok.

--etag -e

Az erőforrás utolsó állapotának megfelelő etag vagy entitáscímke. Ha nincs megadva etag, a rendszer a "*" értéket használja.

--force-string

A "set" vagy a "add" használata esetén a JSON-ra való konvertálás helyett őrizze meg a sztringkonstansokat.

alapértelmezett érték: False

--hub-name -n

IoT Hub neve vagy állomásneve. Kötelező, ha a --login nincs megadva.

--login -l

Ez a parancs egy művelet végrehajtására jogosult entitást kapcsolati sztring támogat. Az "az login" használatával elkerülheti a munkamenet-bejelentkezést. Ha egy entitás kapcsolati sztring és név is meg van adva, a kapcsolati sztring elsőbbséget élvez. Ha a --hub-name nincs megadva, kötelező megadni.

--remove

Tulajdonság vagy elem eltávolítása a listából. Példa: --remove property.list <indexToRemove> VAGY --remove propertyToRemove.

alapértelmezett érték: []

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

--set

Frissítsen egy objektumot egy beállítandó tulajdonság elérési útjának és értékének megadásával. Példa: --set property1.property2=<value>

alapértelmezett érték: []

--tags

Ikercímkék.

Globális paraméterek

--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc

alapértelmezett érték: json

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.