az iot device
Note
Ta dokumentacja jest częścią rozszerzenia azure-iot dla interfejsu wiersza polecenia platformy Azure (wersja 2.67.0 lub nowsza). Rozszerzenie automatycznie zainstaluje polecenie az iot device. Dowiedz się więcej o rozszerzeniach.
Korzystaj z symulacji urządzeń i innych operacji skoncentrowanych na urządzeniach, takich jak urządzenia do chmury lub możliwości obsługi komunikatów z chmury do urządzeń.
Polecenia
| Nazwa | Opis | Typ | Stan |
|---|---|---|---|
| az iot device c2d-message |
Polecenia obsługi komunikatów z chmury do urządzenia. |
Extension | ogólna dostępność |
| az iot device c2d-message abandon |
Porzucanie komunikatu chmura-urządzenie. |
Extension | ogólna dostępność |
| az iot device c2d-message complete |
Ukończ komunikat chmura-urządzenie. |
Extension | ogólna dostępność |
| az iot device c2d-message purge |
Przeczyść kolejkę komunikatów z chmury do urządzenia docelowego. |
Extension | ogólna dostępność |
| az iot device c2d-message receive |
Odbieranie komunikatu z chmury do urządzenia. |
Extension | ogólna dostępność |
| az iot device c2d-message reject |
Odrzucanie lub zakleszczanie komunikatu z chmury do urządzenia. |
Extension | ogólna dostępność |
| az iot device c2d-message send |
Wyślij komunikat z chmury do urządzenia. |
Extension | ogólna dostępność |
| az iot device registration |
Zarządzanie rejestracjami urządzeń IoT dla usługi IoT Device Provisioning. |
Extension | Preview |
| az iot device registration create |
Zarejestruj urządzenie IoT w usłudze IoT Device Provisioning Service. |
Extension | Preview |
| az iot device send-d2c-message |
Wyślij komunikat z urządzenia do chmury mqtt. |
Extension | ogólna dostępność |
| az iot device simulate |
Symulowanie urządzenia w usłudze Azure IoT Hub. |
Extension | Experimental |
| az iot device upload-file |
Przekaż plik lokalny jako urządzenie do wstępnie skonfigurowanego kontenera magazynu obiektów blob. |
Extension | ogólna dostępność |
az iot device send-d2c-message
Wyślij komunikat z urządzenia do chmury mqtt.
Polecenie obsługuje wysyłanie komunikatów z niestandardowym ładunkiem w ciągu Unicode lub formacie binarnym. W przypadku zamiaru wysyłania danych binarnych dane powinny pochodzić z pliku (za pośrednictwem --data-file-path), a typ zawartości powinien mieć wartość application/octet-stream.
Uwaga: Polecenie działa tylko dla urządzeń opartych na uwierzytelniania klucza symetrycznego (SAS). Aby włączyć wykonywanie zapytań względem treści komunikatów w routingu komunikatów, właściwość systemowa typu zawartości musi mieć wartość application/JSON, a właściwość systemu kodowania zawartości musi być jedną z wartości kodowania UTF obsługiwanych przez tę właściwość systemową (UTF-8, UTF-16 lub UTF-32). Jeśli kodowanie zawartości nie jest ustawione, gdy usługa Azure Storage jest używana jako punkt końcowy routingu, usługa IoT Hub zapisuje komunikaty w formacie zakodowanym w formacie base 64. W przypadku używania 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 --cp]
[--da --data]
[--data-file-path --dfp]
[--dtmi --model-id]
[--hub-name]
[--key --symmetric-key]
[--key-file-path --kp]
[--login]
[--mc --msg-count]
[--pass --passphrase]
[--properties --props]
[--resource-group]
Przykłady
Podstawowy sposób użycia
az iot device send-d2c-message -n {iothub_name} -d {device_id}
Podstawowe użycie urządzenia rejestrującego identyfikator modelu "dtmi:com:example:Termostat; 1' po połączeniu
az iot device send-d2c-message -n {iothub_name} -d {device_id} --model-id 'dtmi:com:example:Thermostat;1'
Podstawowe użycie 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 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 z danymi niestandardowymi
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}'
Wysyłanie danych niestandardowych przez określenie typu zawartości i kodowania zawartości we właściwościach systemu
az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.ct={content-type};$.ce={content-encoding}' --data {message_body}
Wysyłanie niestandardowych danych w formacie binarnym przez określenie kodowania zawartości we właściwościach systemu
az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.ct=application/octet-stream' --data-file-path {file_path}
Wysyłanie danych niestandardowych w formacie JSON przez określenie typu zawartości i kodowania zawartości we właściwościach systemu
az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.ct=application/json;$.ce=utf-8' --data-file-path {file_path}
Parametry wymagane
Identyfikator urządzenia docelowego.
Parametry opcjonalne
Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.
Ścieżka do pliku certyfikatu.
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | Device Authentication Arguments |
Treść wiadomości. Podaj tekst lub nieprzetworzone dane json.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | Ping from Az CLI IoT Extension |
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.
Identyfikator modelu usługi Digital Twin, który urządzenie będzie raportować podczas nawiązywania połączenia z koncentratorem. Aby uzyskać więcej informacji, zobacz https://learn.microsoft.com/en-us/azure/iot-develop/overview-iot-plug-and-play.
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | Digital Twin Arguments |
Nazwa lub nazwa hosta usługi IoT Hub. Wymagane, jeśli nie podano opcji --login.
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | IoT Hub Identifier Arguments |
Klucz symetryczny do użycia dla urządzenia. Jeśli podano klucz symetryczny i inne argumenty uwierzytelniania urządzenia, klucz symetryczny ma priorytet.
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | Device Authentication Arguments |
Ścieżka do pliku klucza.
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | Device Authentication Arguments |
To polecenie obsługuje parametry połączenia jednostki z uprawnieniami do wykonania akcji. Użyj polecenia , aby uniknąć logowania do 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 --hub-name.
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | IoT Hub Identifier Arguments |
Liczba komunikatów urządzenia do wysłania do usługi IoT Hub.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | 1 |
Hasło dla pliku klucza.
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | Device Authentication Arguments |
Torba właściwości komunikatu w parach klucz-wartość o następującym formacie: a=b; c=d. W przypadku komunikatów mqtt — można wysyłać właściwości systemu przy użyciu $. {name}=value. Na przykład $.cid=12345 ustawia właściwość identyfikatora korelacji systemu. Inne przykłady identyfikatorów właściwości systemu obejmują $.ct dla typu zawartości, $.mid dla identyfikatora komunikatu i $.ce na potrzeby kodowania zawartości.
Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.
Parametry globalne
Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | False |
Pokaż ten komunikat pomocy i zakończ pracę.
Pokaż tylko błędy, pomijając ostrzeżenia.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | False |
Format danych wyjściowych.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | json |
| Dopuszczalne wartości: | json, jsonc, none, table, tsv, yaml, yamlc |
Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.
Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.
Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | False |
az iot device simulate
To polecenie jest eksperymentalne i opracowywane. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus
Symulowanie urządzenia w usłudze Azure IoT Hub.
Gdy symulacja urządzenia jest uruchomiona, urządzenie 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 c2d symulacji http opiera się 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 kodowanie zawartości na wartość utf-8. Może to zostać zastąpione. Uwaga: W przypadku używania 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 --cp]
[--da --data]
[--dtmi --model-id]
[--hub-name]
[--init-reported-properties --irp]
[--key --symmetric-key]
[--key-file-path --kp]
[--login]
[--mc --msg-count]
[--method-response-code --mrc]
[--method-response-payload --mrp]
[--mi --msg-interval]
[--pass --passphrase]
[--properties --props]
[--proto --protocol {http, mqtt}]
[--receive-settle --rs {abandon, complete, reject}]
[--resource-group]
Przykłady
Użycie podstawowe (mqtt)
az iot device simulate -n {iothub_name} -d {device_id}
Podstawowe użycie urządzenia rejestrującego identyfikator modelu "dtmi:com:example:Termostat; 1' po połączeniu (mqtt)
az iot device simulate -n {iothub_name} -d {device_id} --model-id 'dtmi:com:example:Thermostat;1'
Podstawowe użycie 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 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"
Wysyłanie kodu stanu odpowiedzi metody bezpośredniej i ładunku odpowiedzi metody bezpośredniej jako nieprzetworzonego kodu 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łoszonych 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
Odrzuć komunikaty 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
Identyfikator urządzenia docelowego.
Parametry opcjonalne
Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.
Ścieżka do pliku certyfikatu.
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | Device Authentication Arguments |
Treść wiadomości. Podaj tekst lub nieprzetworzone dane json.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | Ping from Az CLI IoT Extension |
Identyfikator modelu usługi Digital Twin, który urządzenie będzie raportować podczas nawiązywania połączenia z koncentratorem. Aby uzyskać więcej informacji, zobacz https://learn.microsoft.com/en-us/azure/iot-develop/overview-iot-plug-and-play.
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | Digital Twin Arguments |
Nazwa lub nazwa hosta usługi IoT Hub. Wymagane, jeśli nie podano opcji --login.
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | IoT Hub Identifier Arguments |
Początkowy stan zgłoszonych właściwości bliźniaczej reprezentacji urządzenia docelowego podczas uruchamiania symulatora. Opcjonalny parametr, obsługiwany tylko dla mqtt.
Klucz symetryczny do użycia dla urządzenia. Jeśli podano klucz symetryczny i inne argumenty uwierzytelniania urządzenia, klucz symetryczny ma priorytet.
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | Device Authentication Arguments |
Ścieżka do pliku klucza.
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | Device Authentication Arguments |
To polecenie obsługuje parametry połączenia jednostki z uprawnieniami do wykonania akcji. Użyj polecenia , aby uniknąć logowania do 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 --hub-name.
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | IoT Hub Identifier Arguments |
Liczba komunikatów urządzenia do wysłania do usługi IoT Hub.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | 100 |
Kod stanu, który ma zostać zwrócony, gdy metoda bezpośrednia jest wykonywana na urządzeniu. Opcjonalny parametr, obsługiwany tylko dla mqtt.
Ładunek do zwrócenia, gdy metoda bezpośrednia jest wykonywana na urządzeniu. Podaj ścieżkę pliku lub nieprzetworzone dane json. Opcjonalny parametr, obsługiwany tylko dla mqtt.
Opóźnienie w sekundach między komunikatami z urządzenia do chmury.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | 3 |
Hasło dla pliku klucza.
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | Device Authentication Arguments |
Torba właściwości komunikatu w parach klucz-wartość o następującym formacie: a=b; c=d. W przypadku komunikatów mqtt — można wysyłać właściwości systemu przy użyciu $. {name}=value. Na przykład $.cid=12345 ustawia właściwość identyfikatora korelacji systemu. Inne przykłady identyfikatorów właściwości systemu obejmują $.ct dla typu zawartości, $.mid dla identyfikatora komunikatu i $.ce na potrzeby kodowania zawartości. W przypadku komunikatów http — właściwości aplikacji są wysyłane przy użyciu polecenia iothub-app-{name}=value, na przykład iothub-app-myprop=myvalue. Właściwości systemu są zazwyczaj poprzedzone prefiksem iothub-{name}, takim jak iothub-correlationid, ale istnieją wyjątki, takie jak typ zawartości i kodowanie zawartości.
Wskazuje protokół komunikatów urządzenie-chmura.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | mqtt |
| Dopuszczalne wartości: | http, mqtt |
Wskazuje, jak rozstrzygnąć odebrane komunikaty z chmury do urządzenia. Obsługiwane tylko w przypadku protokołu HTTP.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | complete |
| Dopuszczalne wartości: | abandon, complete, reject |
Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.
Parametry globalne
Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | False |
Pokaż ten komunikat pomocy i zakończ pracę.
Pokaż tylko błędy, pomijając ostrzeżenia.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | False |
Format danych wyjściowych.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | json |
| Dopuszczalne wartości: | json, jsonc, none, table, tsv, yaml, yamlc |
Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.
Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.
Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | False |
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 --ct
--device-id
--file-path --fp
[--hub-name]
[--login]
[--resource-group]
Parametry wymagane
Typ pliku MIME.
Identyfikator urządzenia docelowego.
Ścieżka do pliku do przekazania.
Parametry opcjonalne
Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.
Nazwa lub nazwa hosta usługi IoT Hub. Wymagane, jeśli nie podano opcji --login.
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | IoT Hub Identifier Arguments |
To polecenie obsługuje parametry połączenia jednostki z uprawnieniami do wykonania akcji. Użyj polecenia , aby uniknąć logowania do 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 --hub-name.
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | IoT Hub Identifier Arguments |
Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.
Parametry globalne
Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | False |
Pokaż ten komunikat pomocy i zakończ pracę.
Pokaż tylko błędy, pomijając ostrzeżenia.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | False |
Format danych wyjściowych.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | json |
| Dopuszczalne wartości: | json, jsonc, none, table, tsv, yaml, yamlc |
Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.
Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.
Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | False |