Udostępnij przez

az iot central device command

Note

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

Uruchom polecenia urządzenia.

Polecenia

Nazwa Opis Typ Stan
az iot central device command history

Uzyskaj szczegółowe informacje dotyczące najnowszego żądania polecenia i odpowiedzi wysłanej na urządzenie.

 Extension ogólna dostępność
az iot central device command run

Uruchom polecenie na urządzeniu i wyświetl skojarzona odpowiedź. Nie monitoruje aktualizacji właściwości, które może wykonać polecenie.

 Extension ogólna dostępność

az iot central device command history

Uzyskaj szczegółowe informacje dotyczące najnowszego żądania polecenia i odpowiedzi wysłanej na urządzenie.

Wyświetla listę najnowszych żądań poleceń i odpowiedzi, które zostały wysłane do urządzenia z usługi IoT Central. Każda aktualizacja wykonywana przez urządzenie we właściwościach urządzenia w wyniku wykonania polecenia nie jest uwzględniana w odpowiedzi.

az iot central device command history --app-id
                                      --cn --command-name
                                      --device-id
                                      [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri --central-dns-suffix]
                                      [--co --component-name]
                                      [--interface-id]
                                      [--mn --module-name]
                                      [--token]

Przykłady

Pokaż odpowiedź polecenia

az iot central device command history --app-id {appid} --device-id {deviceid} --interface-id {interfaceid} --command-name {commandname}

Pokaż odpowiedź polecenia składnika

az iot central device command history --app-id {appid} --device-id {deviceid} --component-name {componentname} --command-name {commandname}

Pokaż odpowiedź polecenia składnika modułu

az iot central device command history --app-id {appid} --device-id {deviceid} --module-name {modulename} --component-name {componentname} --command-name {commandname}

Parametry wymagane

--app-id -n

Identyfikator aplikacji usługi IoT Central, którą chcesz zarządzać. Identyfikator aplikacji można znaleźć na stronie "Informacje" dla aplikacji w menu pomocy.

--cn --command-name

Nazwa polecenia określona w szablonie urządzenia. Nazwa polecenia może być inna niż nazwa wyświetlana polecenia.

--device-id -d

Identyfikator urządzenia docelowego. Identyfikator urządzenia można znaleźć, klikając przycisk Połącz na stronie Szczegóły urządzenia.

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.

--api-version --av
Przestarzałe

Argument "api_version" został wycofany i zostanie usunięty w przyszłej wersji.

Ten parametr polecenia został przestarzały i zostanie zignorowany. W przyszłej wersji będziemy obsługiwać tylko interfejsy API usługi IoT Central z najnowszej wersji ogólnie dostępnej. Jeśli jakikolwiek interfejs API nie jest jeszcze ogólnie dostępny, wywołamy najnowszą wersję zapoznawcza.

Właściwość Wartość
Domyślna wartość: 2022-07-31
Dopuszczalne wartości: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

Sufiks DNS usługi IoT Central skojarzony z aplikacją.

Właściwość Wartość
Domyślna wartość: azureiotcentral.com
--co --component-name

Nazwa składnika urządzenia.

--interface-id -i

Nazwa interfejsu/składnika określona w szablonie urządzenia. Możesz go znaleźć, przechodząc do szablonu urządzenia i wyświetlając tożsamość interfejsu/składnika w ramach odpowiedniej możliwości urządzenia.

--mn --module-name

Nazwa modułu urządzenia.

--token

Jeśli wolisz przesłać żądanie bez uwierzytelniania w interfejsie wiersza polecenia platformy Azure, możesz określić prawidłowy token użytkownika w celu uwierzytelnienia żądania. Musisz określić typ klucza w ramach żądania. Dowiedz się więcej na stronie https://aka.ms/iotcentraldocsapi.

Parametry globalne
--debug

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

Właściwość Wartość
Domyślna wartość: False
--help -h

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

--only-show-errors

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

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--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 az account set -s NAME_OR_ID.

--verbose

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

Właściwość Wartość
Domyślna wartość: False

az iot central device command run

Uruchom polecenie na urządzeniu i wyświetl skojarzona odpowiedź. Nie monitoruje aktualizacji właściwości, które może wykonać polecenie.

--content może być wbudowanym plikiem json lub ścieżką pliku.

az iot central device command run --app-id
                                  --cn --command-name
                                  --content
                                  --device-id
                                  [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                  [--central-api-uri --central-dns-suffix]
                                  [--co --component-name]
                                  [--interface-id]
                                  [--mn --module-name]
                                  [--token]

Przykłady

Uruchom polecenie z ładunkiem wbudowanym. Ładunek powinien znajdować się w obszarze "request" w ciągu json

az iot central device command run --app-id {appid} --device-id {deviceid} --interface-id {interfaceid} --command-name {commandname} --content '{"request": {payload}}'

Polecenie krótkiego uruchomienia ze ścieżką ładunku json.

az iot central device command run -n {appid} -d {deviceid} -i {interfaceid} --cn {commandname} -k {payload_file_path}

Uruchom polecenie składnika.

az iot central device command run -n {appid} -d {deviceid} --co {componentname} --cn {commandname} -k {payload}

Uruchom polecenie składnika modułu.

az iot central device command run -n {appid} -d {deviceid} --mn {modulename} --co {componentname} --cn {commandname} -k {payload}

Parametry wymagane

--app-id -n

Identyfikator aplikacji usługi IoT Central, którą chcesz zarządzać. Identyfikator aplikacji można znaleźć na stronie "Informacje" dla aplikacji w menu pomocy.

--cn --command-name

Nazwa polecenia określona w szablonie urządzenia. Nazwa polecenia może być inna niż nazwa wyświetlana polecenia.

--content -k

Konfiguracja żądania. Podaj ścieżkę do pliku JSON lub nieprzetworzonego ciągu JSON. [Przykład ścieżki pliku: ./path/to/file.json] [Stringified JSON Example: {'a': 'b'}].

--device-id -d

Identyfikator urządzenia docelowego. Identyfikator urządzenia można znaleźć, klikając przycisk Połącz na stronie Szczegóły urządzenia.

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.

--api-version --av
Przestarzałe

Argument "api_version" został wycofany i zostanie usunięty w przyszłej wersji.

Ten parametr polecenia został przestarzały i zostanie zignorowany. W przyszłej wersji będziemy obsługiwać tylko interfejsy API usługi IoT Central z najnowszej wersji ogólnie dostępnej. Jeśli jakikolwiek interfejs API nie jest jeszcze ogólnie dostępny, wywołamy najnowszą wersję zapoznawcza.

Właściwość Wartość
Domyślna wartość: 2022-07-31
Dopuszczalne wartości: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

Sufiks DNS usługi IoT Central skojarzony z aplikacją.

Właściwość Wartość
Domyślna wartość: azureiotcentral.com
--co --component-name

Nazwa składnika urządzenia.

--interface-id -i

Nazwa interfejsu/składnika określona w szablonie urządzenia. Możesz go znaleźć, przechodząc do szablonu urządzenia i wyświetlając tożsamość interfejsu/składnika w ramach odpowiedniej możliwości urządzenia.

--mn --module-name

Nazwa modułu urządzenia.

--token

Jeśli wolisz przesłać żądanie bez uwierzytelniania w interfejsie wiersza polecenia platformy Azure, możesz określić prawidłowy token użytkownika w celu uwierzytelnienia żądania. Musisz określić typ klucza w ramach żądania. Dowiedz się więcej na stronie https://aka.ms/iotcentraldocsapi.

Parametry globalne
--debug

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

Właściwość Wartość
Domyślna wartość: False
--help -h

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

--only-show-errors

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

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--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 az account set -s NAME_OR_ID.

--verbose

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

Właściwość Wartość
Domyślna wartość: False