az iot hub digital-twin

  • Referentie

Notitie

Deze verwijzing maakt deel uit van de Azure-iot-extensie voor de Azure CLI (versie 2.37.0 of hoger). De extensie installeert automatisch de eerste keer dat u een az iot hub digital-twin-opdracht uitvoert. Meer informatie over extensies.

De digitale dubbel van een IoT Hub-apparaat manipuleren en ermee werken.

Opdracht

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

Roep een opdracht op hoofd- of onderdeelniveau van een digital twin-apparaat aan.

 Toestel GA
az iot hub digital-twin show

De digitale dubbel van een IoT Hub-apparaat weergeven.

 Toestel GA
az iot hub digital-twin update

Werk de eigenschappen voor lezen/schrijven van een digital twin-apparaat bij via de JSON-patchspecificatie.

 Toestel GA

az iot hub digital-twin invoke-command

Roep een opdracht op hoofd- of onderdeelniveau van een digital twin-apparaat aan.

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

Voorbeelden

In het algemeen roept u de opdracht aan die een nettolading gebruikt die een bepaalde eigenschap bevat met behulp van inline JSON.

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

Roep de opdracht 'reboot' op hoofdniveau aan die een nettolading met de naam 'delay' nodig heeft die voldoet aan het DTDL-model 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

Roep de opdracht 'getMaxMinReport' aan op onderdeel 'thermostat1' waarvoor geen invoer nodig is.

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

Vereiste parameters

--cn --command-name

Naam van digitale dubbelopdracht.

--device-id -d

Doelapparaat-id.

Optionele parameters

--component-path

Pad naar digitale dubbelonderdelen. Bijvoorbeeld: thermostaat1.

--connect-timeout --cto

Het maximale tijdsinterval, in seconden, dat IoT Hub probeert verbinding te maken met het apparaat.

--hub-name -n

Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.

--login -l

Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.

--payload

JSON-nettoladinginvoer voor opdracht. Geef bestandspad of inline-JSON op.

standaardwaarde: {}
--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--response-timeout --rto

Het maximale tijdsinterval, in seconden, dat de opdracht digitale dubbel wacht op het resultaat.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az iot hub digital-twin show

De digitale dubbel van een IoT Hub-apparaat weergeven.

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

Voorbeelden

De digitale dubbel van het doelapparaat weergeven.

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

Vereiste parameters

--device-id -d

Doelapparaat-id.

Optionele parameters

--hub-name -n

Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.

--login -l

Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az iot hub digital-twin update

Werk de eigenschappen voor lezen/schrijven van een digital twin-apparaat bij via de JSON-patchspecificatie.

Momenteel zijn bewerkingen beperkt tot toevoegen, vervangen en verwijderen.

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

Voorbeelden

Werk een digitale dubbel bij via de JSON-patchspecificatie.

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

Werk een digitale dubbel bij via de JSON-patchspecificatie.

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

Werk een digital twin-eigenschap bij via de JSON-patchspecificatie die is gedefinieerd in een bestand.

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

Vereiste parameters

--device-id -d

Doelapparaat-id.

--json-patch --patch

Een updatespecificatie die wordt beschreven door JSON-patch. Bewerkingen zijn beperkt tot toevoegen, vervangen en verwijderen. Geef bestandspad of inline-JSON op.

Optionele parameters

--etag -e

Etag of entiteitstag die overeenkomt met de laatste status van de resource. Als er geen etag wordt opgegeven, wordt de waarde *gebruikt.

--hub-name -n

Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.

--login -l

Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.