Dela via

az iot hub digital-twin

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). Tillägget installeras automatiskt första gången du kör ett kommandot az iot hub digital-twin. Learn more about extensions.

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.

 Extension GA
az iot hub digital-twin show

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

 Extension GA
az iot hub digital-twin update

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

 Extension GA

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 --command-name
                                       --device-id
                                       [--component-path]
                                       [--connect-timeout --cto]
                                       [--hub-name]
                                       [--login]
                                       [--payload]
                                       [--resource-group]
                                       [--response-timeout --rto]

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Egenskap Värde
Parameter group: Timeout Arguments
--hub-name -n

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

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--login -l

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

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--payload

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

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

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--response-timeout --rto

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

Egenskap Värde
Parameter group: Timeout Arguments
Globala parametrar
--debug

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

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Output format.

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

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

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

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

Egenskap Värde
Standardvärde: False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--hub-name -n

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

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--login -l

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

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Globala parametrar
--debug

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

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Output format.

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

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

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

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

Egenskap Värde
Standardvärde: False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--login -l

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

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Globala parametrar
--debug

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

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Output format.

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

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

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

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

Egenskap Värde
Standardvärde: False