az iot hub digital-twin

  • Reference

Poznámka

Tento odkaz je součástí rozšíření azure-iot pro Azure CLI (verze 2.37.0 nebo vyšší). Rozšíření se automaticky nainstaluje při prvním spuštění příkazu az iot hub digital-twin . Přečtěte si další informace o rozšířeních.

Manipulace s digitálním dvojčetem zařízení IoT Hub a interakce s ním

Příkazy

Name Description Typ Stav
az iot hub digital-twin invoke-command

Vyvolání příkazu na úrovni kořenového adresáře nebo komponenty zařízení digitálního dvojčete

 Rozšíření GA
az iot hub digital-twin show

Zobrazení digitálního dvojčete zařízení IoT Hubu

 Rozšíření GA
az iot hub digital-twin update

Aktualizujte vlastnosti pro čtení a zápis zařízení digitálního dvojčete pomocí specifikace opravy JSON.

 Rozšíření GA

az iot hub digital-twin invoke-command

Vyvolání příkazu na úrovni kořenového adresáře nebo komponenty zařízení digitálního dvojčete

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

Příklady

Obecně platí, že vyvolání příkazu, který přebírá datovou část, která zahrnuje určitou vlastnost pomocí vloženého kódu JSON.

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

Vyvolání příkazu kořenové úrovně reboot, který přebírá datovou část s názvem delay odpovídající modelu 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

Vyvolání příkazu "getMaxMinReport" u komponenty "termostat1", který nepřijímá žádný vstup.

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

Povinné parametry

--cn --command-name

Název příkazu digitálního dvojčete

--device-id -d

ID cílového zařízení.

Volitelné parametry

--component-path

Cesta komponenty digitálního dvojčete. Například: termostat1.

--connect-timeout --cto

Maximální časový interval v sekundách, po který se IoT Hub pokusí připojit k zařízení.

--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--login -l

Tento příkaz podporuje entitu připojovací řetězec s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud jsou připojovací řetězec i název entity zadané připojovací řetězec prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

--payload

Vstup datové části JSON pro příkaz Zadejte cestu k souboru nebo vložený JSON.

výchozí hodnota: {}
--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--response-timeout --rto

Maximální časový interval v sekundách, po který příkaz digitálního dvojčete počká na výsledek.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot hub digital-twin show

Zobrazení digitálního dvojčete zařízení IoT Hubu

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

Příklady

Zobrazí digitální dvojče cílového zařízení.

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

Povinné parametry

--device-id -d

ID cílového zařízení.

Volitelné parametry

--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--login -l

Tento příkaz podporuje entitu připojovací řetězec s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud jsou připojovací řetězec i název entity zadané připojovací řetězec prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot hub digital-twin update

Aktualizujte vlastnosti pro čtení a zápis zařízení digitálního dvojčete pomocí specifikace opravy JSON.

V současné době jsou operace omezené na přidání, nahrazení a odebrání.

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

Příklady

Aktualizace digitálního dvojčete prostřednictvím specifikace oprav JSON

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

Aktualizace digitálního dvojčete prostřednictvím specifikace oprav 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}
]'

Aktualizujte vlastnost digitálního dvojčete prostřednictvím specifikace opravy JSON definované v souboru.

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

Povinné parametry

--device-id -d

ID cílového zařízení.

--json-patch --patch

Specifikace aktualizace popsaná ve formátu JSON-patch. Operace jsou omezené na přidání, nahrazení a odebrání. Zadejte cestu k souboru nebo vložený JSON.

Volitelné parametry

--etag -e

Značka Etag nebo značka entity odpovídající poslednímu stavu prostředku. Pokud není k dispozici žádná značka etag, použije se hodnota *.

--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--login -l

Tento příkaz podporuje entitu připojovací řetězec s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud jsou připojovací řetězec i název entity zadané připojovací řetězec prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.