az iot hub digital-twin

  • 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 hub digital-twin . Dowiedz się więcej o rozszerzeniach.

Manipulowanie cyfrową reprezentacją bliźniaczą urządzenia usługi IoT Hub i interakcja z nią.

Polecenia

Nazwa Opis Typ Stan
az iot hub digital-twin invoke-command

Wywołaj polecenie na poziomie katalogu głównego lub składnika urządzenia cyfrowej reprezentacji bliźniaczej.

 Numer wewnętrzny Ogólna dostępność
az iot hub digital-twin show

Pokaż cyfrową reprezentację bliźniaczego urządzenia usługi IoT Hub.

 Numer wewnętrzny Ogólna dostępność
az iot hub digital-twin update

Zaktualizuj właściwości odczytu i zapisu urządzenia cyfrowej reprezentacji bliźniaczej za pomocą specyfikacji poprawek JSON.

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

az iot hub digital-twin invoke-command

Wywołaj polecenie na poziomie katalogu głównego lub składnika urządzenia cyfrowej reprezentacji bliźniaczej.

az iot hub digital-twin invoke-command --cn
                                       --device-id
                                       [--component-path]
                                       [--connect-timeout]
                                       [--hub-name]
                                       [--login]
                                       [--payload]
                                       [--resource-group]
                                       [--response-timeout]

Przykłady

Ogólnie rzecz biorąc, wywołaj polecenie, które przyjmuje ładunek zawierający pewną właściwość przy użyciu wbudowanego kodu JSON.

az iot hub digital-twin invoke-command --command-name {command_name} -n {iothub_name} -d {device_id} --payload '{"property_name": "property_value"}'

Wywołaj polecenie poziomu głównego "reboot", które przyjmuje ładunek o nazwie "delay" zgodny z modelem DTDL https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/samples/TemperatureController.json.

az iot hub digital-twin invoke-command --command-name reboot -n {iothub_name} -d {device_id} --payload 5

Wywołaj polecenie "getMaxMinReport" w składniku "termostat1", które nie pobiera żadnych danych wejściowych.

az iot hub digital-twin invoke-command --cn getMaxMinReport -n {iothub_name} -d {device_id} --component-path thermostat1

Parametry wymagane

--cn --command-name

Nazwa polecenia cyfrowej reprezentacji bliźniaczej.

--device-id -d

Identyfikator urządzenia docelowego.

Parametry opcjonalne

--component-path

Ścieżka składnika cyfrowej reprezentacji bliźniaczej. Na przykład: termostat1.

--connect-timeout --cto

Maksymalny interwał czasu (w sekundach), który usługa IoT Hub podejmie próbę nawiązania połączenia z urządzeniem.

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

--payload

Dane wejściowe ładunku JSON dla polecenia. Podaj ścieżkę pliku lub wbudowany kod JSON.

wartość domyślna: {}
--resource-group -g

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

--response-timeout --rto

Maksymalny interwał czasu (w sekundach), że polecenie cyfrowej reprezentacji bliźniaczej będzie czekać na wynik.

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 hub digital-twin show

Pokaż cyfrową reprezentację bliźniaczego urządzenia usługi IoT Hub.

az iot hub digital-twin show --device-id
                             [--hub-name]
                             [--login]
                             [--resource-group]

Przykłady

Pokaż urządzenie docelowe cyfrowej reprezentacji bliźniaczej.

az iot hub digital-twin show -n {iothub_name} -d {device_id}

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 hub digital-twin update

Zaktualizuj właściwości odczytu i zapisu urządzenia cyfrowej reprezentacji bliźniaczej za pomocą specyfikacji poprawek JSON.

Obecnie operacje są ograniczone do dodawania, zastępowania i usuwania.

az iot hub digital-twin update --device-id
                               --json-patch
                               [--etag]
                               [--hub-name]
                               [--login]
                               [--resource-group]

Przykłady

Aktualizowanie cyfrowej reprezentacji bliźniaczej za pomocą specyfikacji poprawek JSON.

az iot hub digital-twin update --hub-name {iothub_name} --device-id {device_id} --json-patch '{"op":"add", "path":"/thermostat1/targetTemperature", "value": 54}'

Aktualizowanie cyfrowej reprezentacji bliźniaczej za pomocą specyfikacji poprawek JSON.

az iot hub digital-twin update -n {iothub_name} -d {device_id} --json-patch '[
  {"op":"remove", "path":"/thermostat1/targetTemperature"},
  {"op":"add", "path":"/thermostat2/targetTemperature", "value": 22}
]'

Zaktualizuj właściwość cyfrowej reprezentacji bliźniaczej za pomocą specyfikacji poprawki JSON zdefiniowanej w pliku.

az iot hub digital-twin update -n {iothub_name} -d {device_id} --json-patch ./my/patch/document.json

Parametry wymagane

--device-id -d

Identyfikator urządzenia docelowego.

--json-patch --patch

Specyfikacja aktualizacji opisana przez JSON-patch. Operacje są ograniczone do dodawania, zastępowania i usuwania. Podaj ścieżkę pliku lub wbudowany kod JSON.

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.