az iot hub module-twin
Notitie
Deze verwijzing maakt deel uit van de Azure-iot-extensie voor de Azure CLI (versie 2.46.0 of hoger). De extensie installeert automatisch de eerste keer dat u een az iot hub module-twin-opdracht uitvoert. Meer informatie over extensies.
Configuratie van IoT-apparaatmoduledubbel beheren.
Opdracht
Name | Description | Type | Status |
---|---|---|---|
az iot hub module-twin replace |
Vervang een definitie van een moduledubbel door doel-json. |
Toestel | GA |
az iot hub module-twin show |
Een definitie van een moduledubbel weergeven. |
Toestel | GA |
az iot hub module-twin update |
De gewenste eigenschappen en tags van de moduledubbel bijwerken. |
Toestel | GA |
az iot hub module-twin replace
Vervang een definitie van een moduledubbel door doel-json.
Voer json rechtstreeks in of gebruik een bestandspad.
az iot hub module-twin replace --device-id
--json
--module-id
[--auth-type {key, login}]
[--etag]
[--hub-name]
[--login]
[--resource-group]
Voorbeelden
Vervang een moduledubbel door bestandsinhoud.
az iot hub module-twin replace -d {device_id} -n {iothub_name} -m {module_name} -j ../mymodtwin.json
Vereiste parameters
Doelapparaat-id.
Json om bestaande dubbel te vervangen door. Geef bestandspad of onbewerkte json op.
Doelmodule-id.
Optionele parameters
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>
.
Etag of entiteitstag die overeenkomt met de laatste status van de resource. Als er geen etag wordt opgegeven, wordt de waarde *gebruikt.
Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.
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.
De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>
.
Globale parameters
Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Dit Help-bericht weergeven en afsluiten.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID
.
Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.
az iot hub module-twin show
Een definitie van een moduledubbel weergeven.
az iot hub module-twin show --device-id
--module-id
[--auth-type {key, login}]
[--hub-name]
[--login]
[--resource-group]
Vereiste parameters
Doelapparaat-id.
Doelmodule-id.
Optionele parameters
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>
.
Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.
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.
De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>
.
Globale parameters
Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Dit Help-bericht weergeven en afsluiten.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID
.
Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.
az iot hub module-twin update
De gewenste eigenschappen en tags van de moduledubbel bijwerken.
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 module-twin update --device-id
--module-id
[--add]
[--auth-type {key, login}]
[--desired]
[--etag]
[--force-string]
[--hub-name]
[--login]
[--remove]
[--resource-group]
[--set]
[--tags]
Voorbeelden
Gewenste eigenschappen van patchmoduledubbel.
az iot hub module-twin update -n {iothub_name} -d {device_id} -m {module_id} --desired '{"conditions":{"temperature":{"warning":70, "critical":100}}}'
Patchmoduledubbeltags.
az iot hub module-twin update -n {iothub_name} -d {device_id} -m {module_id} --tags '{"country": "USA"}'
Patchmoduledubbeltags met JSON-bestandsinhoud.
az iot hub module-twin update -n {iothub_name} -d {device_id} -m {module_id} --tags /path/to/file
Patch verwijderen van 'kritieke' gewenste eigenschap van bovenliggende 'temperatuur'
az iot hub module-twin update -n {iothub_name} -d {device_id} -m {module_id} --desired '{"condition":{"temperature":{"critical": null}}}'
Vereiste parameters
Doelapparaat-id.
Doelmodule-id.
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 or JSON string>
.
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>
.
Gewenste eigenschappen van dubbel.
Etag of entiteitstag die overeenkomt met de laatste status van de resource. Als er geen etag wordt opgegeven, wordt de waarde *gebruikt.
Wanneer u 'set' of 'toevoegen' gebruikt, behoudt u letterlijke tekenreeksen in plaats van te converteren naar JSON.
Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.
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.
Een eigenschap of element uit een lijst verwijderen. Voorbeeld: --remove property.list <indexToRemove>
OF --remove propertyToRemove
.
De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>
.
Werk een object bij door een eigenschapspad en waarde op te geven die u wilt instellen. Voorbeeld: --set property1.property2=<value>
.
Dubbeltags.
Globale parameters
Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Dit Help-bericht weergeven en afsluiten.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID
.
Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.