az iot hub digital-twin

  • Referens

Kommentar

Den här referensen är en del av azure-iot-tillägget för Azure CLI (version 2.46.0 eller senare). Tillägget installeras automatiskt första gången du kör ett az iot hub digital-twin-kommando . Läs mer om tillägg.

Manipulera och interagera med den digitala tvillingen för en IoT Hub-enhet.

Kommandon

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

Anropa ett kommando på rot- eller komponentnivå för en digital tvillingenhet.

 Anknytning Allmän tillgänglighet
az iot hub digital-twin show

Visa den digitala tvillingen för en IoT Hub-enhet.

 Anknytning Allmän tillgänglighet
az iot hub digital-twin update

Uppdatera skrivskyddade egenskaper för en digital tvillingenhet via JSON-korrigeringsspecifikationen.

 Anknytning Allmän tillgänglighet

az iot hub digital-twin invoke-command

Anropa ett kommando på rot- eller komponentnivå för en digital tvillingenhet.

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

Exempel

I allmänhet anropar du kommandot som tar en nyttolast som innehåller vissa egenskaper med hjälp av infogad JSON.

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

Anropa kommandot "reboot" på rotnivå som tar en nyttolast med namnet "delay" som överensstämmer med DTDL-modellen 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

Anropa kommandot "getMaxMinReport" på komponenten "thermostat1" som inte tar några indata.

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

Obligatoriska parametrar

--cn --command-name

Kommandonamn för digital tvilling.

--device-id -d

Målenhets-ID.

Valfria parametrar

--component-path

Komponentsökväg för digital tvilling. Till exempel: termostat1.

--connect-timeout --cto

Maximalt tidsintervall i sekunder som IoT Hub försöker ansluta till enheten.

--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

--login -l

Det här kommandot stöder en entitet niska veze med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet niska veze och namn anges prioriteras niska veze. Krävs om --hub-name inte anges.

--payload

JSON-nyttolastindata för kommandot. Ange filsökväg eller infogad JSON.

Standardvärde: {}
--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--response-timeout --rto

Maximalt tidsintervall, i sekunder, som digital tvilling-kommandot väntar på resultatet.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot hub digital-twin show

Visa den digitala tvillingen för en IoT Hub-enhet.

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

Exempel

Visa målenhetens digitala tvilling.

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

Obligatoriska parametrar

--device-id -d

Målenhets-ID.

Valfria parametrar

--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

--login -l

Det här kommandot stöder en entitet niska veze med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet niska veze och namn anges prioriteras niska veze. Krävs om --hub-name inte anges.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot hub digital-twin update

Uppdatera skrivskyddade egenskaper för en digital tvillingenhet via JSON-korrigeringsspecifikationen.

För närvarande är åtgärderna begränsade till att lägga till, ersätta och ta bort.

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

Exempel

Uppdatera en digital tvilling via JSON-korrigeringsspecifikationen.

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

Uppdatera en digital tvilling via JSON-korrigeringsspecifikationen.

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}
]'

Uppdatera en digital tvillingegenskap via JSON-korrigeringsspecifikationen som definierats i en fil.

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

Obligatoriska parametrar

--device-id -d

Målenhets-ID.

--json-patch --patch

En uppdateringsspecifikation som beskrivs av JSON-patch. Åtgärderna är begränsade till att lägga till, ersätta och ta bort. Ange filsökväg eller infogad JSON.

Valfria parametrar

--etag -e

Etag eller entitetstagg som motsvarar resursens sista tillstånd. Om ingen etag anges används värdet *.

--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

--login -l

Det här kommandot stöder en entitet niska veze med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet niska veze och namn anges prioriteras niska veze. Krävs om --hub-name inte anges.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.