az iot device

Odwołanie

Uwaga

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

Korzystaj z symulacji urządzeń i innych operacji skoncentrowanych na urządzeniach, takich jak możliwości obsługi komunikatów z urządzenia do chmury lub chmury do urządzenia.

Polecenia

az iot device c2d-message	Polecenia obsługi komunikatów z chmury do urządzenia.
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 registration	Zarządzanie rejestracjami urządzeń IoT dla usługi IoT Device Provisioning.
az iot device registration create	Rejestrowanie urządzenia IoT w usłudze IoT Device Provisioning Service.
az iot device send-d2c-message	Wyślij komunikat z urządzenia do chmury mqtt. Polecenie obsługuje wysyłanie komunikatów z właściwościami aplikacji i systemu. Uwaga: W przypadku korzystania z metod uwierzytelniania x509 należy podać pliki certyfikatu i klucza (i hasło, jeśli to konieczne).
az iot device simulate	Symulowanie urządzenia w Azure IoT Hub. Gdy symulacja urządzenia jest uruchomiona, urządzenie będzie automatycznie odbierać i potwierdzać komunikaty z chmury do urządzenia (c2d). W przypadku symulacji mqtt wszystkie komunikaty c2d zostaną potwierdzone wraz z ukończeniem. W przypadku potwierdzenia http symulacja c2d jest oparta na wyborze użytkownika, które można ukończyć, odrzucić lub porzucić. Symulacja mqtt obsługuje również wywołanie metody bezpośredniej, które można potwierdzić za pomocą kodu stanu odpowiedzi i ładunku odpowiedzi. Uwaga: polecenie domyślnie ustawi typ zawartości na wartość application/json i content-encoding na wartość utf-8. Można to zastąpić. Uwaga: W przypadku korzystania z metod uwierzytelniania x509 należy podać pliki certyfikatu i klucza (i hasło, jeśli to konieczne).
az iot device upload-file	Przekaż plik lokalny jako urządzenie do wstępnie skonfigurowanego kontenera magazynu obiektów blob.

az iot device send-d2c-message

Wyślij komunikat z urządzenia do chmury mqtt. Polecenie obsługuje wysyłanie komunikatów z właściwościami aplikacji i systemu. Uwaga: W przypadku korzystania z metod uwierzytelniania x509 należy podać pliki certyfikatu i klucza (i hasło, jeśli to konieczne).

az iot device send-d2c-message --device-id
                               [--certificate-file-path]
                               [--da]
                               [--hub-name]
                               [--key]
                               [--key-file-path]
                               [--login]
                               [--mc]
                               [--pass]
                               [--properties]
                               [--resource-group]

Przykłady

Podstawowy sposób użycia

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

Podstawowe użycie dla urządzenia z uwierzytelnianiem x509

az iot device send-d2c-message -n {iothub_name} -d {device_id} --cp {certificate_file_path} --kp {key_file_path}

Podstawowe użycie dla urządzenia z uwierzytelnianiem x509, w którym plik klucza ma hasło

az iot device send-d2c-message -n {iothub_name} -d {device_id} --cp {certificate_file_path} --kp {key_file_path} --pass {passphrase}

Podstawowe użycie przy użyciu danych niestandardowych

az iot device send-d2c-message -n {iothub_name} -d {device_id} --data {message_body}

Wysyłanie właściwości aplikacji

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

Wysyłanie właściwości systemu (identyfikator komunikatu i identyfikator korelacji)

az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.mid=<id>;$.cid=<id>'

Parametry wymagane

--device-id -d

Urządzenie docelowe.

Parametry opcjonalne

--certificate-file-path --cp

Ścieżka do pliku certyfikatu.

--da --data

Treść wiadomości.

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

--hub-name -n

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

--key --symmetric-key

Klucz symetryczny do użycia dla urządzenia. Jeśli podano klucz symetryczny i inne argumenty uwierzytelniania urządzenia, klucz symetryczny ma priorytet.

--key-file-path --kp

Ścieżka do pliku klucza.

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

--mc --msg-count

Liczba komunikatów urządzenia do wysłania do IoT Hub.

wartość domyślna: 1

--pass --passphrase

Hasło dla pliku klucza.

--properties --props -p

--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ładów.

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

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

az iot device simulate

Symulowanie urządzenia w Azure IoT Hub. Gdy symulacja urządzenia jest uruchomiona, urządzenie będzie automatycznie odbierać i potwierdzać komunikaty z chmury do urządzenia (c2d). W przypadku symulacji mqtt wszystkie komunikaty c2d zostaną potwierdzone wraz z ukończeniem. W przypadku potwierdzenia http symulacja c2d jest oparta na wyborze użytkownika, które można ukończyć, odrzucić lub porzucić. Symulacja mqtt obsługuje również wywołanie metody bezpośredniej, które można potwierdzić za pomocą kodu stanu odpowiedzi i ładunku odpowiedzi. Uwaga: polecenie domyślnie ustawi typ zawartości na wartość application/json i content-encoding na wartość utf-8. Można to zastąpić. Uwaga: W przypadku korzystania z metod uwierzytelniania x509 należy podać pliki certyfikatu i klucza (i hasło, jeśli to konieczne).

az iot device simulate --device-id
                       [--certificate-file-path]
                       [--da]
                       [--hub-name]
                       [--init-reported-properties]
                       [--key]
                       [--key-file-path]
                       [--login]
                       [--mc]
                       [--method-response-code]
                       [--method-response-payload]
                       [--mi]
                       [--pass]
                       [--properties]
                       [--proto {http, mqtt}]
                       [--receive-settle {abandon, complete, reject}]
                       [--resource-group]

Przykłady

Podstawowe użycie (mqtt)

az iot device simulate -n {iothub_name} -d {device_id}

Podstawowe użycie dla urządzenia z uwierzytelnianiem x509 (mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --cp {certificate_file_path} --kp {key_file_path}

Podstawowe użycie dla urządzenia z uwierzytelnianiem x509 (mqtt), w którym plik klucza ma hasło

az iot device simulate -n {iothub_name} -d {device_id} --cp {certificate_file_path} --kp {key_file_path} --pass {passphrase}

Wysyłanie właściwości mieszanych (mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --properties "myprop=myvalue;$.ct=application/json"

Wyślij kod stanu odpowiedzi metody bezpośredniej i ładunek odpowiedzi metody bezpośredniej jako nieprzetworzone dane json (tylko mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --method-response-code 201 --method-response-payload '{"result":"Direct method successful"}'

Wyślij kod stanu odpowiedzi metody bezpośredniej i ładunek odpowiedzi metody bezpośredniej jako ścieżkę do pliku lokalnego (tylko mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --method-response-code 201 --method-response-payload '../my_direct_method_payload.json'

Wyślij początkowy stan zgłaszanej właściwości bliźniaczej reprezentacji urządzenia jako nieprzetworzone dane json dla urządzenia docelowego (tylko mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --init-reported-properties '{"reported_prop_1":"val_1", "reported_prop_2":val_2}'

Wyślij początkowy stan zgłoszonych właściwości bliźniaczej reprezentacji urządzenia jako ścieżkę do pliku lokalnego dla urządzenia docelowego (tylko mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --init-reported-properties '../my_device_twin_reported_properties.json'

Podstawowe użycie (http)

az iot device simulate -n {iothub_name} -d {device_id} --protocol http

Wysyłanie właściwości mieszanych (http)

az iot device simulate -n {iothub_name} -d {device_id} --protocol http --properties "iothub-app-myprop=myvalue;content-type=application/json;iothub-correlationid=12345"

Wybierz łączną liczbę komunikatów i interwał między komunikatami

az iot device simulate -n {iothub_name} -d {device_id} --msg-count 1000 --msg-interval 5

Odrzucanie komunikatów c2d (tylko http)

az iot device simulate -n {iothub_name} -d {device_id} --rs reject --protocol http

Porzucanie komunikatów c2d (tylko http)

az iot device simulate -n {iothub_name} -d {device_id} --rs abandon --protocol http

Parametry wymagane

--device-id -d

Urządzenie docelowe.

Parametry opcjonalne

--certificate-file-path --cp

Ścieżka do pliku certyfikatu.

--da --data

Treść wiadomości.

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

--hub-name -n

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

--init-reported-properties --irp

Początkowy stan zgłaszanej reprezentacji bliźniaczej właściwości urządzenia docelowego po uruchomieniu symulatora. Opcjonalny parametr, obsługiwany tylko w przypadku mqtt.

--key --symmetric-key

Klucz symetryczny do użycia dla urządzenia. Jeśli podano klucz symetryczny i inne argumenty uwierzytelniania urządzenia, klucz symetryczny ma priorytet.

--key-file-path --kp

Ścieżka do pliku klucza.

--login -l

--mc --msg-count

Liczba komunikatów urządzenia do wysłania do IoT Hub.

wartość domyślna: 100

--method-response-code --mrc

Kod stanu, który ma zostać zwrócony po wykonaniu metody bezpośredniej na urządzeniu. Opcjonalny parametr, obsługiwany tylko w przypadku mqtt.

--method-response-payload --mrp

Ładunek, który ma zostać zwrócony po wykonaniu metody bezpośredniej na urządzeniu. Podaj ścieżkę pliku lub nieprzetworzone dane json. Opcjonalny parametr, obsługiwany tylko w przypadku mqtt.

--mi --msg-interval

Opóźnienie w sekundach między komunikatami z urządzenia do chmury.

wartość domyślna: 3

--pass --passphrase

Hasło dla pliku klucza.

--properties --props -p

Torba właściwości komunikatu w parach klucz-wartość z następującym formatem: a=b;c=d. W przypadku komunikatów mqtt — można wysyłać właściwości systemu przy użyciu polecenia $. =value. Na przykład $.cid=12345 ustawia właściwość identyfikatora korelacji systemu. Inne przykłady identyfikatorów właściwości systemowych obejmują $.ct dla typu zawartości, $.mid dla identyfikatora komunikatu i $.ce do kodowania zawartości. W przypadku komunikatów http — właściwości aplikacji są wysyłane przy użyciu polecenia iothub-app-=value, na przykład iothub-app-myprop=myvalue. Właściwości systemu są zazwyczaj poprzedzone ciągiem iothub— takim jak iothub-correlationid, ale istnieją wyjątki, takie jak typ zawartości i kodowanie zawartości.

--proto --protocol

Wskazuje protokół komunikatów z urządzenia do chmury.

akceptowane wartości: http, mqtt

wartość domyślna: mqtt

--receive-settle --rs

Wskazuje sposób rozliczania odebranych komunikatów z chmury do urządzenia. Obsługiwane tylko przy użyciu protokołu HTTP.

akceptowane wartości: abandon, complete, reject

wartość domyślna: complete

--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ładów.

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

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

az iot device upload-file

Przekaż plik lokalny jako urządzenie do wstępnie skonfigurowanego kontenera magazynu obiektów blob.

az iot device upload-file --content-type
                          --device-id
                          --file-path
                          [--hub-name]
                          [--login]
                          [--resource-group]

Parametry wymagane

--content-type --ct

Typ pliku MIME.

--device-id -d

Urządzenie docelowe.

--file-path --fp

Ścieżka do pliku do przekazania.

Parametry opcjonalne

--hub-name -n

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

--login -l

--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ładów.

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

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