Udostępnij przez

az iot hub module-twin

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

Zarządzanie konfiguracją bliźniaczej reprezentacji modułu urządzenia IoT.

Polecenia

Nazwa Opis Typ Stan
az iot hub module-twin replace

Zastąp definicję bliźniaczej reprezentacji modułu docelowym kodem json.

 Extension ogólna dostępność
az iot hub module-twin show

Pokaż definicję bliźniaczej reprezentacji modułu.

 Extension ogólna dostępność
az iot hub module-twin update

Zaktualizuj żądane właściwości i tagi bliźniaczej reprezentacji modułu.

 Extension ogólna dostępność

az iot hub module-twin replace

Zastąp definicję bliźniaczej reprezentacji modułu docelowym kodem json.

Dane wejściowe w formacie JSON bezpośrednio lub użyj ścieżki pliku.

az iot hub module-twin replace --device-id
                               --json
                               --module-id
                               [--auth-type {key, login}]
                               [--etag]
                               [--hub-name]
                               [--login]
                               [--resource-group]

Przykłady

Zastąp bliźniacze reprezentację modułu zawartością pliku.

az iot hub module-twin replace -d {device_id} -n {iothub_name} -m {module_name} -j ../mymodtwin.json

Parametry wymagane

--device-id -d

Identyfikator urządzenia docelowego.

--json -j

Plik Json, aby zastąpić istniejącą reprezentację bliźniacza. Podaj ścieżkę pliku lub nieprzetworzone dane json.

--module-id -m

Identyfikator modułu 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.

--auth-type

Wskazuje, czy operacja powinna automatycznie utworzyć klucz zasad, czy użyć bieżącej sesji usługi Azure AD. Jeśli typ uwierzytelniania to identyfikator logowania i zostanie podana nazwa hosta zasobu, wyszukiwanie zasobów zostanie pominięte, chyba że będzie to konieczne. Wartość domyślną można skonfigurować przy użyciu az configure --defaults iothub-data-auth-type={auth-type-value}.

Właściwość Wartość
Grupa parametrów: Access Control Arguments
Domyślna wartość: key
Dopuszczalne wartości: key, login
--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.

Właściwość Wartość
Grupa parametrów: IoT Hub Identifier Arguments
--login -l

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
--resource-group -g

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

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

Pokaż definicję bliźniaczej reprezentacji modułu.

az iot hub module-twin show --device-id
                            --module-id
                            [--auth-type {key, login}]
                            [--hub-name]
                            [--login]
                            [--resource-group]

Parametry wymagane

--device-id -d

Identyfikator urządzenia docelowego.

--module-id -m

Identyfikator modułu 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.

--auth-type

Wskazuje, czy operacja powinna automatycznie utworzyć klucz zasad, czy użyć bieżącej sesji usługi Azure AD. Jeśli typ uwierzytelniania to identyfikator logowania i zostanie podana nazwa hosta zasobu, wyszukiwanie zasobów zostanie pominięte, chyba że będzie to konieczne. Wartość domyślną można skonfigurować przy użyciu az configure --defaults iothub-data-auth-type={auth-type-value}.

Właściwość Wartość
Grupa parametrów: Access Control Arguments
Domyślna wartość: key
Dopuszczalne wartości: key, login
--hub-name -n

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

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
--resource-group -g

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

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

Zaktualizuj żądane właściwości i tagi bliźniaczej reprezentacji modułu.

Podaj argumenty --desired lub --tags dla zachowania PATCH. Oba parametry obsługują wbudowany kod json lub ścieżkę pliku do zawartości json. Użycie ogólnych args aktualizacji (tj. --set) będzie odzwierciedlać zachowanie PUT i są przestarzałe.

az iot hub module-twin update --device-id
                              --module-id
                              [--add]
                              [--auth-type {key, login}]
                              [--desired]
                              [--etag]
                              [--force-string]
                              [--hub-name]
                              [--login]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--tags]

Przykłady

Poprawianie żądanych właściwości bliźniaczej reprezentacji modułu.

az iot hub module-twin update -n {iothub_name} -d {device_id} -m {module_id} --desired '{"conditions":{"temperature":{"warning":70, "critical":100}}}'

Stosowanie poprawek tagów bliźniaczych reprezentacji modułu.

az iot hub module-twin update -n {iothub_name} -d {device_id} -m {module_id} --tags '{"country": "USA"}'

Stosowanie poprawek tagów bliźniaczych reprezentacji modułu z zawartością pliku JSON.

az iot hub module-twin update -n {iothub_name} -d {device_id} -m {module_id} --tags /path/to/file

Usunięcie poprawki żądanej właściwości "krytycznej" z nadrzędnej "temperatury"

az iot hub module-twin update -n {iothub_name} -d {device_id} -m {module_id} --desired '{"condition":{"temperature":{"critical": null}}}'

Parametry wymagane

--device-id -d

Identyfikator urządzenia docelowego.

--module-id -m

Identyfikator modułu 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.

--add

Dodaj obiekt do listy obiektów, określając pary ścieżki i wartości klucza. Przykład: --add property.listProperty <key=value, string or JSON string>.

Właściwość Wartość
Grupa parametrów: Generic Update Arguments
Domyślna wartość: []
--auth-type

Wskazuje, czy operacja powinna automatycznie utworzyć klucz zasad, czy użyć bieżącej sesji usługi Azure AD. Jeśli typ uwierzytelniania to identyfikator logowania i zostanie podana nazwa hosta zasobu, wyszukiwanie zasobów zostanie pominięte, chyba że będzie to konieczne. Wartość domyślną można skonfigurować przy użyciu az configure --defaults iothub-data-auth-type={auth-type-value}.

Właściwość Wartość
Grupa parametrów: Access Control Arguments
Domyślna wartość: key
Dopuszczalne wartości: key, login
--desired

Żądane właściwości bliźniaczej reprezentacji.

Właściwość Wartość
Grupa parametrów: Twin Patch Arguments
--etag -e

Etag lub tag jednostki odpowiadający ostatniemu stanowi zasobu. Jeśli nie podano elementu etag, zostanie użyta wartość "*".

--force-string

W przypadku używania polecenia "set" lub "add" zachowaj literały ciągu zamiast próbować konwertować na format JSON.

Właściwość Wartość
Grupa parametrów: Generic Update Arguments
Domyślna wartość: False
--hub-name -n

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

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

Usuń właściwość lub element z listy. Przykład: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Właściwość Wartość
Grupa parametrów: Generic Update Arguments
Domyślna wartość: []
--resource-group -g

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

--set

Zaktualizuj obiekt, określając ścieżkę właściwości i wartość do ustawienia. Przykład: --set property1.property2=<value>.

Właściwość Wartość
Grupa parametrów: Generic Update Arguments
Domyślna wartość: []
--tags

Tagi bliźniaczych reprezentacji.

Właściwość Wartość
Grupa parametrów: Twin Patch Arguments
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