az iot device c2d-message

  • Reference

Poznámka

Tento odkaz je součástí rozšíření azure-iot pro Azure CLI (verze 2.37.0 nebo vyšší). Rozšíření se automaticky nainstaluje při prvním spuštění příkazu az iot device c2d-message . Přečtěte si další informace o rozšířeních.

Příkazy zasílání zpráv typu Cloud-zařízení

Příkazy

Name Description Typ Stav
az iot device c2d-message abandon

Opusťte zprávu typu cloud-zařízení.

 Rozšíření GA
az iot device c2d-message complete

Dokončete zprávu typu cloud-zařízení.

 Rozšíření GA
az iot device c2d-message purge

Vyprázdnění fronty zpráv typu cloud-zařízení pro cílové zařízení

 Rozšíření GA
az iot device c2d-message receive

Obdrží zprávu typu cloud-zařízení.

 Rozšíření GA
az iot device c2d-message reject

Odmítnutí nebo zablokování zprávy typu cloud-zařízení

 Rozšíření GA
az iot device c2d-message send

Odeslání zprávy typu cloud-zařízení

 Rozšíření GA

az iot device c2d-message abandon

Opusťte zprávu typu cloud-zařízení.

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

Povinné parametry

--device-id -d

ID cílového zařízení.

Volitelné parametry

--etag -e

Značka Etag nebo značka entity odpovídající poslednímu stavu prostředku. Pokud není k dispozici žádná značka etag, použije se hodnota *.

--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--login -l

Tento příkaz podporuje entitu připojovací řetězec s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud jsou připojovací řetězec i název entity zadané připojovací řetězec prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot device c2d-message complete

Dokončete zprávu typu cloud-zařízení.

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

Povinné parametry

--device-id -d

ID cílového zařízení.

Volitelné parametry

--etag -e

Značka Etag nebo značka entity odpovídající poslednímu stavu prostředku. Pokud není k dispozici žádná značka etag, použije se hodnota *.

--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--login -l

Tento příkaz podporuje entitu připojovací řetězec s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud jsou připojovací řetězec i název entity zadané připojovací řetězec prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot device c2d-message purge

Vyprázdnění fronty zpráv typu cloud-zařízení pro cílové zařízení

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

Povinné parametry

--device-id -d

ID cílového zařízení.

Volitelné parametry

--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--login -l

Tento příkaz podporuje entitu připojovací řetězec s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud jsou připojovací řetězec i název entity zadané připojovací řetězec prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot device c2d-message receive

Obdrží zprávu typu cloud-zařízení.

Text přijaté zprávy bude dekódován pouze v případě, že je jeho kódování obsahu nastaveno na "utf-8", 'utf-16' nebo 'utf-32'. Datová část zprávy se zobrazí jako {{nedekódovatelná datová část}}, pokud kódování obsahu není nastaveno na jednu z výše uvedených hodnot nebo se nepodaří dekódovat ani v případě, že je kódování obsahu nastavené na jednu z výše uvedených možností.

Poznámka: Akceptuje se pouze jeden argument ack zprávy [--complete, --reject, --abandon].

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říklady

Základní použití

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

Přijetí zprávy a nastavení časového limitu uzamčení 30 sekund pro tuto zprávu

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

Přijetí zprávy a jeho dokončení po přijetí

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

Přijmout zprávu a odmítnout ji po přijetí

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

Povinné parametry

--device-id -d

ID cílového zařízení.

Volitelné parametry

--abandon

Po přijetí opusťte zprávu typu cloud-zařízení.

přijímané hodnoty: false, true
výchozí hodnota: False
--complete

Po potvrzení dokončete zprávu typu cloud-zařízení.

přijímané hodnoty: false, true
výchozí hodnota: False
--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--lock-timeout --lt

Určuje dobu, po kterou bude zpráva pro ostatní přijímat volání neviditelná.

výchozí hodnota: 60
--login -l

Tento příkaz podporuje entitu připojovací řetězec s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud jsou připojovací řetězec i název entity zadané připojovací řetězec prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

--reject

Po potvrzení odmítněte zprávu typu cloud-zařízení.

přijímané hodnoty: false, true
výchozí hodnota: False
--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot device c2d-message reject

Odmítnutí nebo zablokování zprávy typu cloud-zařízení

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

Povinné parametry

--device-id -d

ID cílového zařízení.

Volitelné parametry

--etag -e

Značka Etag nebo značka entity odpovídající poslednímu stavu prostředku. Pokud není k dispozici žádná značka etag, použije se hodnota *.

--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--login -l

Tento příkaz podporuje entitu připojovací řetězec s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud jsou připojovací řetězec i název entity zadané připojovací řetězec prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot device c2d-message send

Odeslání zprávy typu cloud-zařízení

Tento příkaz spoléhá na závislý balíček Cython (uamqp) a při prvním spuštění může nainstalovat závislý balíček Cython. https://github.com/Azure/azure-uamqp-python

Poznámka: Kódování obsahu je ve výchozím nastavení nastaveno na utf-8. Příkaz odešle text zprávy s akcí kódování, pokud je vlastnost content-encoding buď utf-8, utf-16 nebo utf-32. Pokud hodnota kódování obsahu není jednou z těchto hodnot, bude vlastnost stále odeslána bez provedení akce kódování.

Při odesílání textu binární zprávy musí být obsah poskytnut ze souboru (prostřednictvím --data-file-path) a typ obsahu musí být nastaven na application/octet-stream.

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říklady

Základní použití s výchozím textem zprávy

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

Odeslání zprávy typu cloud-zařízení s vlastními daty a vlastnostmi

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

Odeslání zprávy C2D a čekání na potvrzení zařízení

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

Odešle zprávu C2D v binárním formátu ze souboru.

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

Odešle zprávu C2D ve formátu JSON ze souboru.

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

Povinné parametry

--device-id -d

ID cílového zařízení.

Volitelné parametry

--ack

Požádejte o doručení zpětné vazby na jednotlivé zprávy týkající se konečného stavu této zprávy. Popis hodnot ack je následující. Pozitivní: Pokud zpráva c2d dosáhne stavu Dokončeno, IoT Hub vygeneruje zprávu zpětné vazby. Negativní: Pokud zpráva c2d dosáhne stavu nedoručených zpráv, IoT Hub vygeneruje zprávu zpětné vazby. Úplné: IoT Hub vygeneruje zprávu zpětné vazby v obou případech. Ve výchozím nastavení se nevyžaduje žádná ack.

přijímané hodnoty: full, negative, positive
--auth-type

Určuje, jestli má operace automaticky odvodit klíč zásady, nebo použít aktuální relaci Azure AD. Pokud je typ ověřování přihlášení a zadá se název hostitele prostředku, bude vyhledávání prostředků vynecháno, pokud není potřeba. Výchozí nastavení můžete nakonfigurovat pomocí az configure --defaults iothub-data-auth-type=<auth-type-value>.

přijímané hodnoty: key, login
výchozí hodnota: key
--ce --content-encoding

Kódování textu zprávy C2D.

výchozí hodnota: utf-8
--cid --correlation-id

ID korelace přidružené ke zprávě C2D.

--content-type --ct

Typ obsahu textu zprávy C2D.

--da --data

Text zprávy Zadejte text nebo nezpracovaný json.

výchozí hodnota: Ping from Az CLI IoT Extension
--data-file-path --dfp
Preview

Zadejte cestu k souboru pro datovou část textu zprávy. Upozorňujeme, že je potřeba datovou část odeslat v binárním formátu, nastavte typ obsahu na application/octet-stream.

--expiry --expiry-time-utc

Jednotky jsou milisekundy od epochy unixu. Pokud není zadaný žádný čas, použije se výchozí hodnota TTL zprávy ioT HubU C2D.

--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--login -l

Tento příkaz podporuje entitu připojovací řetězec s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud jsou připojovací řetězec i název entity zadané připojovací řetězec prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

--message-id --mid

ID zprávy C2D. Pokud není zadané ID zprávy, vygeneruje se UUID.

--properties --props -p

Taška vlastností zprávy ve dvojicích klíč-hodnota s následujícím formátem: a=b; c=d.

--repair -r

Přeinstalujte závislost uamqp kompatibilní s verzí rozšíření. Výchozí hodnota: false.

přijímané hodnoty: false, true
výchozí hodnota: False
--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--uid --user-id

Zpráva C2D, vlastnost ID uživatele.

--wait -w

Pokud nastavíte operaci odeslání c2d, zablokuje se až do přijetí zpětné vazby zařízení.

přijímané hodnoty: false, true
výchozí hodnota: False
--yes -y

Přeskočte výzvy uživatele. Označuje přijetí akce. Používá se především pro scénáře automatizace. Výchozí hodnota: false.

přijímané hodnoty: false, true
výchozí hodnota: False
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.