az iot device c2d-message

Uwaga

Ta dokumentacja jest częścią rozszerzenia azure-iot dla interfejsu wiersza polecenia platformy Azure (wersja 2.30.0 lub nowsza). Rozszerzenie automatycznie zainstaluje polecenie az iot device c2d-message po raz pierwszy. Dowiedz się więcej o rozszerzeniach.

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

Polecenia

az iot device c2d-message abandon	Porzucanie komunikatu z chmury do urządzenia.
az iot device c2d-message complete	Ukończ komunikat z chmury do urządzenia.
az iot device c2d-message purge	Przeczyść kolejkę komunikatów z chmury do urządzenia docelowego.
az iot device c2d-message receive	Odbieranie komunikatu z chmury do urządzenia.
az iot device c2d-message reject	Odrzucanie lub zakleszczenie komunikatu z chmury do urządzenia.
az iot device c2d-message send	Wyślij komunikat z chmury do urządzenia.

az iot device c2d-message abandon

Porzucanie komunikatu z chmury do urządzenia.

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

Parametry wymagane

--device-id -d

Urządzenie docelowe.

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

IoT Hub nazwa. Wymagane, jeśli nie podano --login.

--login -l

To polecenie obsługuje parametry połączenia jednostki z prawami do wykonania akcji. Użyj polecenia , aby uniknąć logowania sesji za pomocą polecenia "az login". Jeśli parametry połączenia jednostki i nazwa są podane parametry połączenia mają priorytet. Wymagane, jeśli nie podano nazwy --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.

--query

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

--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 --debug, aby uzyskać pełne dzienniki debugowania.

az iot device c2d-message complete

Ukończ komunikat z chmury do urządzenia.

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

Parametry wymagane

--device-id -d

Urządzenie docelowe.

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

IoT Hub nazwa. Wymagane, jeśli nie podano --login.

--login -l

To polecenie obsługuje parametry połączenia jednostki z prawami do wykonania akcji. Użyj polecenia , aby uniknąć logowania sesji za pomocą polecenia "az login". Jeśli parametry połączenia jednostki i nazwa są podane parametry połączenia mają priorytet. Wymagane, jeśli nie podano nazwy --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.

--query

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

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

Urządzenie docelowe.

Parametry opcjonalne

--hub-name -n

IoT Hub nazwa. Wymagane, jeśli nie podano --login.

--login -l

To polecenie obsługuje parametry połączenia jednostki z prawami do wykonania akcji. Użyj polecenia , aby uniknąć logowania sesji za pomocą polecenia "az login". Jeśli parametry połączenia jednostki i nazwa są podane parametry połączenia mają priorytet. Wymagane, jeśli nie podano nazwy --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.

--query

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

--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 --debug, aby uzyskać pełne dzienniki debugowania.

az iot device c2d-message receive

Odbieranie komunikatu z chmury do urządzenia.

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 ack go jako "complete" po odebraniu

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

Odbieranie komunikatu i odrzucanie go po odebraniu

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

Parametry wymagane

--device-id -d

Urządzenie docelowe.

Parametry opcjonalne

--abandon

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

akceptowane wartości: false, true

--complete

Ukończ komunikat z chmury do urządzenia po otrzymaniu.

akceptowane wartości: false, true

--hub-name -n

IoT Hub nazwa. Wymagane, jeśli nie podano --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 parametry połączenia jednostki z prawami do wykonania akcji. Użyj polecenia , aby uniknąć logowania sesji za pomocą polecenia "az login". Jeśli parametry połączenia jednostki i nazwa są podane parametry połączenia mają priorytet. Wymagane, jeśli nie podano nazwy --hub-name.

--reject

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

akceptowane wartości: false, true

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

--query

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

--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 --debug, aby uzyskać pełne dzienniki debugowania.

az iot device c2d-message reject

Odrzucanie lub zakleszczenie 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

Urządzenie docelowe.

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

IoT Hub nazwa. Wymagane, jeśli nie podano --login.

--login -l

To polecenie obsługuje parametry połączenia jednostki z prawami do wykonania akcji. Użyj polecenia , aby uniknąć logowania sesji za pomocą polecenia "az login". Jeśli parametry połączenia jednostki i nazwa są podane parametry połączenia mają priorytet. Wymagane, jeśli nie podano nazwy --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.

--query

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

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

az iot device c2d-message send --device-id
                               [--ack {full, negative, positive}]
                               [--auth-type {key, login}]
                               [--ce]
                               [--cid]
                               [--content-type]
                               [--da]
                               [--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}

Wyślij komunikat 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

Parametry wymagane

--device-id -d

Urządzenie docelowe.

Parametry opcjonalne

--ack

Zażądaj dostarczenia opinii dotyczącej komunikatu dotyczącego końcowego stanu tej wiadomości. Opis wartości ack jest następujący. Pozytywny: jeśli komunikat c2d osiągnie stan Ukończono, IoT Hub generuje komunikat opinii. Ujemne: jeśli komunikat c2d osiągnie stan Martwy, IoT Hub generuje komunikat opinii. Pełny: IoT Hub generuje komunikat opinii w obu przypadkach. Domyślnie nie jest wymagane żadne żądanie ack.

akceptowane wartości: full, negative, positive

--auth-type

Wskazuje, czy operacja powinna automatycznie uzyskać klucz zasad, czy użyć bieżącej sesji Azure AD. 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.

wartość domyślna: Ping from Az CLI IoT Extension

--expiry --expiry-time-utc

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

--hub-name -n

IoT Hub nazwa. Wymagane, jeśli nie podano --login.

--login -l

To polecenie obsługuje parametry połączenia jednostki z prawami do wykonania akcji. Użyj polecenia , aby uniknąć logowania sesji za pomocą polecenia "az login". Jeśli parametry połączenia jednostki i nazwa są podane parametry połączenia mają priorytet. Wymagane, jeśli nie podano nazwy --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ść z następującym formatem: a=b;c=d.

--repair -r

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

akceptowane wartości: false, true

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

Komunikat C2D, właściwość Identyfikator użytkownika.

--wait -w

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

akceptowane wartości: false, true

--yes -y

Pomiń monity użytkownika. Wskazuje akceptację instalacji zależności (jeśli jest to wymagane). Używane głównie w scenariuszach automatyzacji. Wartość domyślna: false.

akceptowane wartości: false, true

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.

--query

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

--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 --debug, aby uzyskać pełne dzienniki debugowania.