az iot hub device-twin
Notitie
Deze referentie maakt deel uit van de azure-iot-extensie voor Azure CLI en vereist versie 2.17.1 of hoger. De extensie wordt automatisch geïnstalleerd wanneer u de opdracht az iot hub device-twin voor het eerst gebruikt. Meer informatie over extensies.
Configuratie van IoT-apparaattwee beheren.
Opdracht
| az iot hub device-twin replace |
Vervang de definitie van de apparaattwee door de doel-json. |
| az iot hub device-twin show |
Haal een definitie van een apparaattweeling op. |
| az iot hub device-twin update |
Werk de gewenste eigenschappen en tags van de apparaattweeling bij. |
az iot hub device-twin replace
Vervang de definitie van de apparaattwee 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 de apparaat dubbel door bestandsinhoud.
az iot hub device-twin replace -d {device_id} -n {iothub_name} -j ../mydevicetwin.json
Vereiste parameters
Doelapparaat.
Json om de bestaande tweeling door te vervangen. Geef het bestandspad of de onbewerkte json op.
Optionele parameters
Geeft aan of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. U kunt de standaardinstelling configureren met az configure --defaults iothub-data-auth-type=<auth-type-value> behulp van .
Etag of entiteitstag die overeenkomt met de laatste status van de resource. Als er geen etag is opgegeven, wordt de waarde * ' ' gebruikt.
IoT Hub naam.
Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
Vergroot de logboekbebossing om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.
az iot hub device-twin show
Haal een definitie van een apparaattweeling op.
az iot hub device-twin show --device-id
[--auth-type {key, login}]
[--hub-name]
[--login]
[--resource-group]
Vereiste parameters
Doelapparaat.
Optionele parameters
Geeft aan of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. U kunt de standaardinstelling configureren met az configure --defaults iothub-data-auth-type=<auth-type-value> behulp van .
IoT Hub naam.
Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
Vergroot de logboekbebossing om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.
az iot hub device-twin update
Werk de gewenste eigenschappen en tags van de apparaattweeling bij.
Geef --desired of --tags argumenten op voor PATCH-gedrag. Het gebruik van algemene update-args (dat wil zeggen --set) weerspiegelt PUT-gedrag en is 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
Patchen van de gewenste eigenschappen van de apparaattwee.
az iot hub device-twin update -n {iothub_name} -d {device_id} --desired '{"conditions":{"temperature":{"warning":70, "critical":100}}}'
Patchen voor apparaattweetags.
az iot hub device-twin update -n {iothub_name} -d {device_id} --tags '{"country": "USA"}'
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
Doelapparaat.
Optionele parameters
Voeg een -object toe aan een lijst met objecten door een pad- en sleutelwaardeparen op te geven. Voorbeeld: --add property.listProperty <key=value, string of JSON string>.
Geeft aan of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. U kunt de standaardinstelling configureren met az configure --defaults iothub-data-auth-type=<auth-type-value> behulp van .
Gewenste dubbeleigenschappen.
Etag of entiteitstag die overeenkomt met de laatste status van de resource. Als er geen etag is opgegeven, wordt de waarde * ' ' gebruikt.
Wanneer u 'set' of 'add' gebruikt, behoudt u letterlijke tekenreeksen in plaats van te proberen te converteren naar JSON.
IoT Hub naam.
Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.
Verwijder een eigenschap of een element uit een lijst. Voorbeeld: --remove property.list OR --remove propertyToRemove.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
Werk een object bij door een eigenschapspad en waarde op te geven die moeten worden ingesteld. Voorbeeld: --set property1.property2=.
Dubbeltags.
Vergroot de logboekbebossing om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.