az iot device c2d-message

Feljegyzés

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

Felhőalapú üzenetkezelési parancsok.

Parancsok

Name	Description	Típus	Állapot
az iot device c2d-message abandon	Felhőből eszközre irányuló üzenet elhagyása.	Mellék	FE
az iot device c2d-message complete	Töltsön ki egy felhőből eszközre irányuló üzenetet.	Mellék	FE
az iot device c2d-message purge	Felhőből eszközre irányuló üzenetsor törlése egy céleszközhöz.	Mellék	FE
az iot device c2d-message receive	Üzenet fogadása felhőről eszközre.	Mellék	FE
az iot device c2d-message reject	Felhőből eszközre irányuló üzenet elvetése vagy letiltása.	Mellék	FE
az iot device c2d-message send	Küldjön egy felhőből az eszközre irányuló üzenetet.	Mellék	FE

az iot device c2d-message abandon

Felhőből eszközre irányuló üzenet elhagyása.

az iot device c2d-message abandon --device-id
                                  [--etag]
                                  [--hub-name]
                                  [--login]
                                  [--resource-group]

Kötelező paraméterek

--device-id -d

Céleszköz-azonosító.

Opcionális paraméterek

--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 device c2d-message complete

Töltsön ki egy felhőből eszközre irányuló üzenetet.

az iot device c2d-message complete --device-id
                                   [--etag]
                                   [--hub-name]
                                   [--login]
                                   [--resource-group]

Kötelező paraméterek

--device-id -d

Céleszköz-azonosító.

Opcionális paraméterek

--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 device c2d-message purge

Felhőből eszközre irányuló üzenetsor törlése egy céleszközhöz.

az iot device c2d-message purge --device-id
                                [--hub-name]
                                [--login]
                                [--resource-group]

Kötelező paraméterek

--device-id -d

Céleszköz-azonosító.

Opcionális paraméterek

--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 device c2d-message receive

Üzenet fogadása felhőről eszközre.

A kapott üzenettörzs csak akkor lesz dekódolva, ha a tartalomkódolás értéke "utf-8", "utf-16" vagy "utf-32". Az üzenet hasznos adattartalma {{nem dekódolható hasznos adat}} néven jelenik meg, ha a tartalomkódolás nem a fentiek egyikére van beállítva, vagy még akkor sem sikerül dekódolni, ha a tartalomkódolás a fentiek egyikére van beállítva.

Megjegyzés: A rendszer csak egy [--complete, --reject, --abandon] argumentumot fogad el.

az iot device c2d-message receive --device-id
                                  [--abandon {false, true}]
                                  [--complete {false, true}]
                                  [--hub-name]
                                  [--lock-timeout]
                                  [--login]
                                  [--reject {false, true}]
                                  [--resource-group]

Példák

Alapszintű használat

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group}

Üzenet fogadása és 30 másodperces zárolási időtúllépés beállítása az üzenethez

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --lt {30}

Üzenet fogadása és "készként" való megjelölése a fogadás után

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --complete

Üzenet fogadása és elutasítása a fogadás után

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --reject

Kötelező paraméterek

--device-id -d

Céleszköz-azonosító.

Opcionális paraméterek

--abandon

A beérkezés után hagyja fel a felhőből az eszközre irányuló üzenetet.

Elfogadott értékek: false, true

Alapértelmezett érték: False

--complete

A beérkezés után töltse ki a felhőből az eszközre irányuló üzenetet.

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.

--lock-timeout --lt

Azt határozza meg, hogy az üzenetek mennyi ideig lesznek láthatatlanok más fogadott hívások számára.

Alapértelmezett érték: 60

--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.

--reject

A beérkezés után utasítsa el a felhőből az eszközre irányuló üzenetet.

Elfogadott értékek: false, true

Alapértelmezett érték: False

--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 device c2d-message reject

Felhőből eszközre irányuló üzenet elvetése vagy letiltása.

az iot device c2d-message reject --device-id
                                 [--etag]
                                 [--hub-name]
                                 [--login]
                                 [--resource-group]

Kötelező paraméterek

--device-id -d

Céleszköz-azonosító.

Opcionális paraméterek

--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 device c2d-message send

Küldjön egy felhőből az eszközre irányuló üzenetet.

Ez a parancs az első végrehajtáskor függő Cython-csomagot (uamqp) használ és telepíthet. https://github.com/Azure/azure-uamqp-python

Megjegyzés: A tartalomkódolás alapértelmezés szerint utf-8. A parancs kódolási művelettel küldi el az üzenet törzsét, ha a tartalomkódolási tulajdonság utf-8, utf-16 vagy utf-32. Ha a tartalomkódolási érték nem tartozik ezek közé, a rendszer továbbra is elküldi a tulajdonságot kódolási művelet nélkül.

Bináris üzenettörzs küldésekor a tartalmat egy fájlból kell megadni (via --data-file-path) és a tartalomtípust a következőre application/octet-streamkell állítani: .

az iot device c2d-message send --device-id
                               [--ack {full, negative, positive}]
                               [--auth-type {key, login}]
                               [--ce]
                               [--cid]
                               [--content-type]
                               [--da]
                               [--data-file-path]
                               [--expiry]
                               [--hub-name]
                               [--login]
                               [--message-id]
                               [--properties]
                               [--repair {false, true}]
                               [--resource-group]
                               [--uid]
                               [--wait {false, true}]
                               [--yes {false, true}]

Példák

Alapszintű használat alapértelmezett üzenettörzsgel

az iot device c2d-message send -d {device_id} -n {iothub_name}

Felhőből eszközre irányuló üzenet küldése egyéni adatokkal és tulajdonságokkal.

az iot device c2d-message send -d {device_id} -n {iothub_name} --data 'Hello World' --props 'key0=value0;key1=value1'

C2D-üzenet küldése és várakozás az eszköz nyugtázására

az iot device c2d-message send -d {device_id} -n {iothub_name} --ack full --wait

C2D-üzenet küldése bináris formátumban fájlból.

az iot device c2d-message send -d {device_id} -n {iothub_name} --data-file-path {file_path} --content-type 'application/octet-stream'

C2D-üzenet küldése JSON formátumban fájlból.

az iot device c2d-message send -d {device_id} -n {iothub_name} --data-file-path {file_path} --content-type 'application/json'

Kötelező paraméterek

--device-id -d

Céleszköz-azonosító.

Opcionális paraméterek

--ack

Kérjen visszajelzést az üzenet végleges állapotáról. Az ack értékek leírása a következő. Pozitív: Ha a c2d üzenet eléri a Kész állapotot, az IoT Hub visszajelzési üzenetet hoz létre. Negatív: Ha a c2d üzenet eléri a Holt betűs állapotot, az IoT Hub visszajelzési üzenetet hoz létre. Teljes: Az IoT Hub mindkét esetben visszajelzési üzenetet küld. Alapértelmezés szerint nincs szükség a kérésre.

Elfogadott értékek: full, negative, positive

--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

--ce --content-encoding

A C2D üzenettörzs kódolása.

Alapértelmezett érték: utf-8

--cid --correlation-id

A C2D-üzenethez társított korrelációs azonosító.

--content-type --ct

A C2D-üzenet törzsének tartalomtípusa.

--da --data

Üzenet törzse. Adjon meg szöveget vagy nyers json-t.

Alapértelmezett érték: Ping from Az CLI IoT Extension

--data-file-path --dfp

Előnézet

Adja meg az üzenettörzs hasznos adatfájljának elérési útját. Vegye figyelembe, hogy ha a hasznos adatokat bináris formátumban kell elküldeni, állítsa be a tartalom típusát alkalmazás/oktet-stream értékre.

--expiry --expiry-time-utc

Az egységek a Unix-korszak óta ezredmásodpercek. Ha nincs idő jelezve, az alapértelmezett IoT Hub C2D-üzenet TTL-t használ.

--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.

--message-id --mid

A C2D üzenetazonosítója. Ha nincs megadva üzenetazonosító, a rendszer létrehoz egy UUID azonosítót.

--properties --props -p

Üzenettulajdonság-zsák kulcs-érték párokban a következő formátumban: a=b; c=d.

--repair -r

Telepítse újra a bővítményverzióval kompatibilis uamqp-függőséget. Alapértelmezett érték: false (hamis).

Elfogadott értékek: false, true

Alapértelmezett érték: False

--resource-group -g

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

--uid --user-id

A C2D üzenet felhasználói azonosító tulajdonsága.

--wait -w

Ha be van állítva a c2d küldési művelet, a rendszer letiltja, amíg az eszköz visszajelzése meg nem érkezik.

Elfogadott értékek: false, true

Alapértelmezett érték: False

--yes -y

Felhasználói kérések kihagyása. A művelet elfogadását jelzi. Elsősorban automatizálási forgatókönyvekhez használatos. Alapértelmezett érték: false (hamis).

Elfogadott értékek: false, true

Alapértelmezett érték: False

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.