az iot hub device-twin

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

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

Polecenia

az iot hub device-twin replace

Zastąp definicję bliźniaczej reprezentacji urządzenia docelowym kodem json.
az iot hub device-twin show

Pobierz definicję bliźniaczej reprezentacji urządzenia.
az iot hub device-twin update

Aktualizowanie żądanych właściwości i tagów bliźniaczej reprezentacji urządzenia.

az iot hub device-twin replace

Zastąp definicję bliźniaczej reprezentacji urządzenia docelowym kodem json.

Wprowadź dane json bezpośrednio lub użyj ścieżki pliku.

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

Przykłady

Zastąp bliźniaczą reprezentację urządzenia zawartością pliku.

az iot hub device-twin replace -d {device_id} -n {iothub_name} -j ../mydevicetwin.json

Parametry wymagane

--device-id -d

Urządzenie docelowe.

--json -j

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

Parametry opcjonalne

--auth-type

Wskazuje, czy operacja powinna automatycznie wyprowadzać klucz zasad, czy używać bieżącej sesji Azure AD. Wartość domyślną można skonfigurować przy użyciu polecenia az configure --defaults iothub-data-auth-type=<auth-type-value>.

akceptowane wartości: key, login
wartość domyślna: key
--etag -e

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

--hub-name -n

IoT Hub nazwę. Wymagane, jeśli nie podano opcji --login.

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

--resource-group -g

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

az iot hub device-twin show

Pobierz definicję bliźniaczej reprezentacji urządzenia.

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

Parametry wymagane

--device-id -d

Urządzenie docelowe.

Parametry opcjonalne

--auth-type

Wskazuje, czy operacja powinna automatycznie wyprowadzać klucz zasad, czy używać bieżącej sesji Azure AD. Wartość domyślną można skonfigurować przy użyciu polecenia az configure --defaults iothub-data-auth-type=<auth-type-value>.

akceptowane wartości: key, login
wartość domyślna: key
--hub-name -n

IoT Hub nazwę. Wymagane, jeśli nie podano opcji --login.

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

--resource-group -g

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

az iot hub device-twin update

Aktualizowanie żądanych właściwości i tagów bliźniaczej reprezentacji urządzenia.

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 device-twin update --device-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 urządzenia.

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

Stosowanie poprawek tagów bliźniaczej reprezentacji urządzenia.

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

Stosowanie poprawek tagów bliźniaczej reprezentacji urządzenia przy użyciu zawartości pliku JSON.

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

Usuwanie poprawek żądanej właściwości "krytycznej" z nadrzędnej "temperatury"

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

Parametry wymagane

--device-id -d

Urządzenie docelowe.

Parametry opcjonalne

--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 lub ciąg JSON>.

--auth-type

Wskazuje, czy operacja powinna automatycznie wyprowadzać klucz zasad, czy używać bieżącej sesji Azure AD. Wartość domyślną można skonfigurować przy użyciu polecenia az configure --defaults iothub-data-auth-type=<auth-type-value>.

akceptowane wartości: key, login
wartość domyślna: key
--desired

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

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

--hub-name -n

IoT Hub nazwę. Wymagane, jeśli nie podano opcji --login.

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

--remove

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

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia 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=.

--tags

Tagi bliźniaczych reprezentacji.