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

--device-id -d

Doelapparaat.

--json -j

Json om de bestaande tweeling door te vervangen. Geef het bestandspad of de onbewerkte json op.

Optionele parameters

--auth-type

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 .

geaccepteerde waarden: key, login
standaardwaarde: key
--etag -e

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

--hub-name -n

IoT Hub naam.

--login -l

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.

--resource-group -g

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

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

--device-id -d

Doelapparaat.

Optionele parameters

--auth-type

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 .

geaccepteerde waarden: key, login
standaardwaarde: key
--hub-name -n

IoT Hub naam.

--login -l

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.

--resource-group -g

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

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

--device-id -d

Doelapparaat.

Optionele parameters

--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 of JSON string>.

--auth-type

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 .

geaccepteerde waarden: key, login
standaardwaarde: key
--desired

Gewenste dubbeleigenschappen.

--etag -e

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

--force-string

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

--hub-name -n

IoT Hub naam.

--login -l

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.

--remove

Verwijder een eigenschap of een element uit een lijst. Voorbeeld: --remove property.list OR --remove propertyToRemove.

--resource-group -g

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

--set

Werk een object bij door een eigenschapspad en waarde op te geven die moeten worden ingesteld. Voorbeeld: --set property1.property2=.

--tags

Dubbeltags.