Delen via

az iot hub device-twin

Note

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

Configuratie van IoT-apparaatdubbel beheren.

Opdracht

Name Description Type Status
az iot hub device-twin list

Apparaatdubbels weergeven in een IoT Hub.

 Extension GA
az iot hub device-twin replace

Vervang de definitie van de apparaatdubbel door de doel-json.

 Extension GA
az iot hub device-twin show

Een definitie van een apparaatdubbel ophalen.

 Extension GA
az iot hub device-twin update

Werk de gewenste eigenschappen en tags van apparaatdubbels bij.

 Extension GA

az iot hub device-twin list

Apparaatdubbels weergeven in een IoT Hub.

Deze opdracht is hetzelfde als de iot-hubquery met de query 'select * from devices' voor alle apparaten en 'select * from devices where capabilities.iotEdge = true' voor edge-apparaten. Gebruik az iot hub query deze functie voor krachtigere query's op apparaten.

az iot hub device-twin list [--auth-type {key, login}]
                            [--edge-enabled --ee {false, true}]
                            [--hub-name]
                            [--login]
                            [--resource-group]
                            [--top]

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--auth-type

Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iothub-data-auth-type={auth-type-value}.

Eigenschap Waarde
Parametergroep: Access Control Arguments
Default value: key
Geaccepteerde waarden: key, login
--edge-enabled --ee

Vlag die aangeeft dat edge is ingeschakeld.

Eigenschap Waarde
Default value: False
Geaccepteerde waarden: false, true
--hub-name -n

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

Eigenschap Waarde
Parametergroep: IoT Hub Identifier Arguments
--login -l

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

Eigenschap Waarde
Parametergroep: IoT Hub Identifier Arguments
--resource-group -g

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

--top

Maximum aantal elementen dat moet worden geretourneerd. Gebruik -1 onbeperkt.

Eigenschap Waarde
Default value: 1000
Globale parameters
--debug

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Naam of id van 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.

Eigenschap Waarde
Default value: False

az iot hub device-twin replace

Vervang de definitie van de apparaatdubbel door de doel-json.

Voer json rechtstreeks in of gebruik een bestandspad.

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

Voorbeelden

Vervang apparaatdubbel door bestandsinhoud.

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

Vereiste parameters

--device-id -d

Doelapparaat-id.

--json -j

Json om bestaande dubbel te vervangen door. Geef bestandspad of onbewerkte json op.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--auth-type

Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iothub-data-auth-type={auth-type-value}.

Eigenschap Waarde
Parametergroep: Access Control Arguments
Default value: key
Geaccepteerde waarden: key, login
--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.

Eigenschap Waarde
Parametergroep: IoT Hub Identifier Arguments
--login -l

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

Eigenschap Waarde
Parametergroep: IoT Hub Identifier Arguments
--resource-group -g

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Naam of id van 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.

Eigenschap Waarde
Default value: False

az iot hub device-twin show

Een definitie van een apparaatdubbel ophalen.

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

Vereiste parameters

--device-id -d

Doelapparaat-id.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--auth-type

Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iothub-data-auth-type={auth-type-value}.

Eigenschap Waarde
Parametergroep: Access Control Arguments
Default value: key
Geaccepteerde waarden: key, login
--hub-name -n

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

Eigenschap Waarde
Parametergroep: IoT Hub Identifier Arguments
--login -l

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

Eigenschap Waarde
Parametergroep: IoT Hub Identifier Arguments
--resource-group -g

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Naam of id van 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.

Eigenschap Waarde
Default value: False

az iot hub device-twin update

Werk de gewenste eigenschappen en tags van apparaatdubbels bij.

Geef --gewenste of --tags-argumenten op voor PATCH-gedrag. Beide parameters ondersteunen inline json of een bestandspad naar json-inhoud. Het gebruik van algemene updateargumenten (dat wil zeggen --set) weerspiegelt PUT-gedrag en wordt afgeschaft.

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]

Voorbeelden

Gewenste eigenschappen van apparaatdubbel patchen.

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

Tags voor apparaatdubbels patchen.

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

Patch-tags voor apparaatdubbels met JSON-bestandsinhoud.

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

Patch verwijderen van 'kritieke' gewenste eigenschap van bovenliggende 'temperatuur'

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

Vereiste parameters

--device-id -d

Doelapparaat-id.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--add

Voeg een object toe aan een lijst met objecten door een pad- en sleutelwaardeparen op te geven. Voorbeeld: --add property.listProperty <key=value, string or JSON string>.

Eigenschap Waarde
Parametergroep: Generic Update Arguments
Default value: []
--auth-type

Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iothub-data-auth-type={auth-type-value}.

Eigenschap Waarde
Parametergroep: Access Control Arguments
Default value: key
Geaccepteerde waarden: key, login
--desired

Gewenste eigenschappen van dubbel.

Eigenschap Waarde
Parametergroep: Twin Patch Arguments
--etag -e

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

--force-string

Wanneer u 'set' of 'toevoegen' gebruikt, behoudt u letterlijke tekenreeksen in plaats van te converteren naar JSON.

Eigenschap Waarde
Parametergroep: Generic Update Arguments
Default value: False
--hub-name -n

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

Eigenschap Waarde
Parametergroep: IoT Hub Identifier Arguments
--login -l

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

Eigenschap Waarde
Parametergroep: IoT Hub Identifier Arguments
--remove

Een eigenschap of element uit een lijst verwijderen. Voorbeeld: --remove property.list <indexToRemove> OF --remove propertyToRemove.

Eigenschap Waarde
Parametergroep: Generic Update Arguments
Default value: []
--resource-group -g

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

--set

Werk een object bij door een eigenschapspad en waarde op te geven die u wilt instellen. Voorbeeld: --set property1.property2=<value>.

Eigenschap Waarde
Parametergroep: Generic Update Arguments
Default value: []
--tags

Dubbeltags.

Eigenschap Waarde
Parametergroep: Twin Patch Arguments
Globale parameters
--debug

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Naam of id van 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.

Eigenschap Waarde
Default value: False