az iot device c2d-message

  • Odwołanie

Uwaga

Ta dokumentacja jest częścią rozszerzenia azure-iot dla interfejsu wiersza polecenia platformy Azure (wersja 2.37.0 lub nowsza). Rozszerzenie zostanie automatycznie zainstalowane przy pierwszym uruchomieniu polecenia az iot device c2d-message . Dowiedz się więcej o rozszerzeniach.

Polecenia obsługi komunikatów z chmury do urządzenia.

Polecenia

Nazwa Opis Typ Stan
az iot device c2d-message abandon

Porzucanie komunikatu chmura-urządzenie.

 Numer wewnętrzny Ogólna dostępność
az iot device c2d-message complete

Ukończ komunikat chmura-urządzenie.

 Numer wewnętrzny Ogólna dostępność
az iot device c2d-message purge

Przeczyść kolejkę komunikatów z chmury do urządzenia docelowego.

 Numer wewnętrzny Ogólna dostępność
az iot device c2d-message receive

Odbieranie komunikatu z chmury do urządzenia.

 Numer wewnętrzny Ogólna dostępność
az iot device c2d-message reject

Odrzucanie lub zakleszczanie komunikatu z chmury do urządzenia.

 Numer wewnętrzny Ogólna dostępność
az iot device c2d-message send

Wyślij komunikat z chmury do urządzenia.

 Numer wewnętrzny Ogólna dostępność

az iot device c2d-message abandon

Porzucanie komunikatu chmura-urządzenie.

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

Parametry wymagane

--device-id -d

Identyfikator urządzenia docelowego.

Parametry opcjonalne

--etag -e

Etag lub tag jednostki odpowiadający ostatniemu stanowi zasobu. Jeśli nie podano elementu etag, zostanie użyta wartość "*".

--hub-name -n

Nazwa lub nazwa hosta usługi IoT Hub. Wymagane, jeśli nie podano opcji --login.

--login -l

To polecenie obsługuje jednostkę parametry połączenia z uprawnieniami do wykonania akcji. Użyj polecenia , aby uniknąć logowania do sesji za pomocą polecenia "az login". Jeśli zarówno jednostka parametry połączenia, jak i nazwa są podane, parametry połączenia ma priorytet. Wymagane, jeśli nie podano --hub-name.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

az iot device c2d-message complete

Ukończ komunikat chmura-urządzenie.

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

Parametry wymagane

--device-id -d

Identyfikator urządzenia docelowego.

Parametry opcjonalne

--etag -e

Etag lub tag jednostki odpowiadający ostatniemu stanowi zasobu. Jeśli nie podano elementu etag, zostanie użyta wartość "*".

--hub-name -n

Nazwa lub nazwa hosta usługi IoT Hub. Wymagane, jeśli nie podano opcji --login.

--login -l

To polecenie obsługuje jednostkę parametry połączenia z uprawnieniami do wykonania akcji. Użyj polecenia , aby uniknąć logowania do sesji za pomocą polecenia "az login". Jeśli zarówno jednostka parametry połączenia, jak i nazwa są podane, parametry połączenia ma priorytet. Wymagane, jeśli nie podano --hub-name.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

az iot device c2d-message purge

Przeczyść kolejkę komunikatów z chmury do urządzenia docelowego.

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

Parametry wymagane

--device-id -d

Identyfikator urządzenia docelowego.

Parametry opcjonalne

--hub-name -n

Nazwa lub nazwa hosta usługi IoT Hub. Wymagane, jeśli nie podano opcji --login.

--login -l

To polecenie obsługuje jednostkę parametry połączenia z uprawnieniami do wykonania akcji. Użyj polecenia , aby uniknąć logowania do sesji za pomocą polecenia "az login". Jeśli zarówno jednostka parametry połączenia, jak i nazwa są podane, parametry połączenia ma priorytet. Wymagane, jeśli nie podano --hub-name.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

az iot device c2d-message receive

Odbieranie komunikatu z chmury do urządzenia.

Odebrana treść komunikatu zostanie zdekodowana tylko wtedy, gdy jego kodowanie zawartości ma wartość "utf-8", "utf-16" lub "utf-32". Ładunek komunikatu będzie wyświetlany jako {{nieodkodowany ładunek}}, gdy kodowanie zawartości nie jest ustawione na jeden z powyższych lub nie można dekodować nawet wtedy, gdy kodowanie zawartości jest ustawione na jeden z powyższych.

Uwaga: zostanie zaakceptowany tylko jeden argument ack komunikatu [--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]

Przykłady

Podstawowy sposób użycia

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

Odbieranie komunikatu i ustawianie limitu czasu blokady 30 sekund dla tego komunikatu

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

Odbieranie komunikatu i potwierdzenie go jako "complete" po odebraniu

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

Odbierz komunikat i odrzuć go po odebraniu

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

Parametry wymagane

--device-id -d

Identyfikator urządzenia docelowego.

Parametry opcjonalne

--abandon

Po otrzymaniu po otrzymaniu porzucanie komunikatu z chmury do urządzenia.

akceptowane wartości: false, true
wartość domyślna: False
--complete

Po otrzymaniu ukończ komunikat z chmury do urządzenia.

akceptowane wartości: false, true
wartość domyślna: False
--hub-name -n

Nazwa lub nazwa hosta usługi IoT Hub. Wymagane, jeśli nie podano opcji --login.

--lock-timeout --lt

Określa czas, przez jaki komunikat będzie niewidoczny dla innych połączeń odbieranych.

wartość domyślna: 60
--login -l

To polecenie obsługuje jednostkę parametry połączenia z uprawnieniami do wykonania akcji. Użyj polecenia , aby uniknąć logowania do sesji za pomocą polecenia "az login". Jeśli zarówno jednostka parametry połączenia, jak i nazwa są podane, parametry połączenia ma priorytet. Wymagane, jeśli nie podano --hub-name.

--reject

Odrzuć komunikat z chmury do urządzenia po otrzymaniu.

akceptowane wartości: false, true
wartość domyślna: False
--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

az iot device c2d-message reject

Odrzucanie lub zakleszczanie komunikatu z chmury do urządzenia.

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

Parametry wymagane

--device-id -d

Identyfikator urządzenia docelowego.

Parametry opcjonalne

--etag -e

Etag lub tag jednostki odpowiadający ostatniemu stanowi zasobu. Jeśli nie podano elementu etag, zostanie użyta wartość "*".

--hub-name -n

Nazwa lub nazwa hosta usługi IoT Hub. Wymagane, jeśli nie podano opcji --login.

--login -l

To polecenie obsługuje jednostkę parametry połączenia z uprawnieniami do wykonania akcji. Użyj polecenia , aby uniknąć logowania do sesji za pomocą polecenia "az login". Jeśli zarówno jednostka parametry połączenia, jak i nazwa są podane, parametry połączenia ma priorytet. Wymagane, jeśli nie podano --hub-name.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

az iot device c2d-message send

Wyślij komunikat z chmury do urządzenia.

To polecenie opiera się na i może zainstalować zależny pakiet Cython (uamqp) po pierwszym wykonaniu. https://github.com/Azure/azure-uamqp-python

Uwaga: kodowanie zawartości jest domyślnie ustawione na utf-8. Polecenie wyśle treść komunikatu z akcją kodowania, gdy właściwość kodowania zawartości to utf-8, utf-16 lub utf-32. Jeśli wartość kodowania zawartości nie jest jedną z tych wartości, właściwość będzie nadal wysyłana bez podejmowania akcji kodowania.

Podczas wysyłania treści komunikatu binarnego zawartość musi być dostarczana z pliku (za pośrednictwem --data-file-path), a typ zawartości musi być ustawiony na application/octet-streamwartość .

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

Przykłady

Podstawowe użycie z domyślną treścią komunikatu

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

Wysyłanie komunikatu z chmury do urządzenia przy użyciu niestandardowych danych i właściwości.

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

Wysyłanie komunikatu C2D i oczekiwanie na potwierdzenie urządzenia

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

Wyślij komunikat C2D w formacie binarnym z pliku.

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

Wyślij komunikat C2D w formacie JSON z pliku.

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

Parametry wymagane

--device-id -d

Identyfikator urządzenia docelowego.

Parametry opcjonalne

--ack

Zażądaj dostarczenia opinii na temat końcowego stanu tej wiadomości. Opis wartości ack jest następujący. Pozytywny: jeśli komunikat c2d osiągnie stan Ukończono, usługa IoT Hub generuje komunikat opinii. Negatywna: jeśli komunikat c2d osiągnie stan Utracony, usługa IoT Hub generuje komunikat opinii. Pełne: usługa IoT Hub generuje komunikat opinii w obu przypadkach. Domyślnie nie jest wymagane żadne ack.

akceptowane wartości: full, negative, positive
--auth-type

Wskazuje, czy operacja powinna automatycznie utworzyć klucz zasad, czy użyć bieżącej sesji usługi Azure AD. Jeśli typ uwierzytelniania to identyfikator logowania i zostanie podana nazwa hosta zasobu, wyszukiwanie zasobów zostanie pominięte, chyba że będzie to konieczne. Wartość domyślną można skonfigurować przy użyciu polecenia az configure --defaults iothub-data-auth-type=<auth-type-value>.

akceptowane wartości: key, login
wartość domyślna: key
--ce --content-encoding

Kodowanie treści komunikatu C2D.

wartość domyślna: utf-8
--cid --correlation-id

Identyfikator korelacji skojarzony z komunikatem C2D.

--content-type --ct

Typ zawartości treści komunikatu C2D.

--da --data

Treść wiadomości. Podaj tekst lub nieprzetworzone dane json.

wartość domyślna: Ping from Az CLI IoT Extension
--data-file-path --dfp
Wersja zapoznawcza

Podaj ścieżkę do pliku dla ładunku treści komunikatu. Pamiętaj, że gdy ładunek musi być wysyłany w formacie binarnym, ustaw typ zawartości na wartość application/octet-stream.

--expiry --expiry-time-utc

Jednostki są milisekundami od epoki unix. Jeśli nie określono czasu, jest używany domyślny czas wygaśnięcia komunikatu C2D usługi IoT Hub.

--hub-name -n

Nazwa lub nazwa hosta usługi IoT Hub. Wymagane, jeśli nie podano opcji --login.

--login -l

To polecenie obsługuje jednostkę parametry połączenia z uprawnieniami do wykonania akcji. Użyj polecenia , aby uniknąć logowania do sesji za pomocą polecenia "az login". Jeśli zarówno jednostka parametry połączenia, jak i nazwa są podane, parametry połączenia ma priorytet. Wymagane, jeśli nie podano --hub-name.

--message-id --mid

Identyfikator komunikatu C2D. Jeśli nie podano identyfikatora komunikatu, zostanie wygenerowany identyfikator UUID.

--properties --props -p

Torba właściwości komunikatu w parach klucz-wartość o następującym formacie: a=b; c=d.

--repair -r

Zainstaluj ponownie zależność uamqp zgodną z wersją rozszerzenia. Wartość domyślna: false.

akceptowane wartości: false, true
wartość domyślna: False
--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

--uid --user-id

Właściwość C2D message, user Id.

--wait -w

Jeśli ustawisz operację wysyłania c2d, zostanie zablokowana do momentu otrzymania opinii o urządzeniu.

akceptowane wartości: false, true
wartość domyślna: False
--yes -y

Pomiń monity użytkownika. Wskazuje akceptację akcji. Używane głównie w scenariuszach automatyzacji. Wartość domyślna: false.

akceptowane wartości: false, true
wartość domyślna: False
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.