az iot du instance
Note
Den här referensen är en del av azure-iot-tillägget för Azure CLI (version 2.67.0 eller senare). Tillägget installeras automatiskt första gången du kör ett az iot du-instans kommando. Läs mer om tillägg.
Hantering av enhetsuppdateringsinstanser.
Kommandon
| Name | Description | Typ | Status |
|---|---|---|---|
| az iot du instance create |
Skapa en enhetsuppdateringsinstans. |
Extension | GA |
| az iot du instance delete |
Ta bort en instans av enhetsuppdatering. |
Extension | GA |
| az iot du instance list |
Visa en lista över instanser av enhetsuppdatering. |
Extension | GA |
| az iot du instance show |
Visa en instans av enhetsuppdatering. |
Extension | GA |
| az iot du instance update |
Uppdatera en enhetsuppdateringsinstans. |
Extension | GA |
| az iot du instance wait |
Blockera tills ett önskat instansresurstillstånd har uppfyllts. |
Extension | GA |
az iot du instance create
Skapa en enhetsuppdateringsinstans.
Det här kommandot kan också användas för att uppdatera tillståndet för en befintlig instans.
az iot du instance create --account
--instance
--iothub-ids
[--diagnostics-storage-id]
[--enable-diagnostics {false, true}]
[--no-wait]
[--resource-group]
[--tags]
Exempel
Skapa en instans med minsta möjliga konfiguration.
az iot du instance create -n {account_name} -i {instance_name} --iothub-ids {iothub_resource_id}
Skapa en instans med diagnostik aktiverad, tillsammans med ett användarangivet lagringskonto. Inkludera taggar.
az iot du instance create -n {account_name} -i {instance_name} --iothub-ids {iothub_resource_id} --enable-diagnostics --diagnostics-storage-id {storage_account_resource_id} --tags a=b
Obligatoriska parametrar
Namn på enhetsuppdateringskonto. Du kan konfigurera standardkontonamnet med hjälp av az config set defaults.adu_account={name}.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Account Identifier Arguments |
Namnet på enhetsuppdateringsinstansen. Du kan konfigurera standardinstansnamnet med hjälp av az config set defaults.adu_instance={name}.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Account Identifier Arguments |
Resurs-ID:t för utrymmesavgränsade IoT Hub.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | IoT Hub Arguments |
Valfria parametrar
Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.
Användardefinerat resurs-ID för lagringskonto för användning i insamling av diagnostikloggar.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Storage Arguments |
Aktiverar insamling av diagnostikloggar.
| Egenskap | Värde |
|---|---|
| Godkända värden: | false, true |
Vänta inte tills den långvariga åtgärden har slutförts.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Namn på resursgrupp för enhetsuppdateringskonto. Du kan konfigurera standardgruppen med hjälp av az config set defaults.adu_group={name}.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Account Identifier Arguments |
Resursetiketter. Egenskapsväska i nyckel/värde-par med följande format: a=b c=d.
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
az iot du instance delete
Ta bort en instans av enhetsuppdatering.
az iot du instance delete --account
--instance
[--no-wait]
[--resource-group]
[--yes {false, true}]
Exempel
Ta bort en instans som är associerad med målkontot.
az iot du instance delete -n {account_name} -i {instance_name}
Ta bort en instans som är associerad med målkontot och hoppa över bekräftelseprompten.
az iot du instance delete -n {account_name} -i {instance_name} -y
Obligatoriska parametrar
Namn på enhetsuppdateringskonto. Du kan konfigurera standardkontonamnet med hjälp av az config set defaults.adu_account={name}.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Account Identifier Arguments |
Namnet på enhetsuppdateringsinstansen. Du kan konfigurera standardinstansnamnet med hjälp av az config set defaults.adu_instance={name}.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Account Identifier Arguments |
Valfria parametrar
Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.
Vänta inte tills den långvariga åtgärden har slutförts.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Namn på resursgrupp för enhetsuppdateringskonto. Du kan konfigurera standardgruppen med hjälp av az config set defaults.adu_group={name}.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Account Identifier Arguments |
Hoppa över användarprompter. Anger godkännande av åtgärd. Används främst för automatiseringsscenarier. Standard: falskt.
| Egenskap | Värde |
|---|---|
| Godkända värden: | false, true |
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
az iot du instance list
Visa en lista över instanser av enhetsuppdatering.
az iot du instance list --account
[--resource-group]
Exempel
Lista instanser som är associerade med målkontot.
az iot du instance list -n {account_name}
Obligatoriska parametrar
Namn på enhetsuppdateringskonto. Du kan konfigurera standardkontonamnet med hjälp av az config set defaults.adu_account={name}.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Account Identifier Arguments |
Valfria parametrar
Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.
Namn på resursgrupp för enhetsuppdateringskonto. Du kan konfigurera standardgruppen med hjälp av az config set defaults.adu_group={name}.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Account Identifier Arguments |
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
az iot du instance show
Visa en instans av enhetsuppdatering.
az iot du instance show --account
--instance
[--resource-group]
Exempel
Visa information om en instans som är associerad med målkontot.
az iot du instance show -n {account_name} -i {instance_name}
Obligatoriska parametrar
Namn på enhetsuppdateringskonto. Du kan konfigurera standardkontonamnet med hjälp av az config set defaults.adu_account={name}.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Account Identifier Arguments |
Namnet på enhetsuppdateringsinstansen. Du kan konfigurera standardinstansnamnet med hjälp av az config set defaults.adu_instance={name}.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Account Identifier Arguments |
Valfria parametrar
Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.
Namn på resursgrupp för enhetsuppdateringskonto. Du kan konfigurera standardgruppen med hjälp av az config set defaults.adu_group={name}.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Account Identifier Arguments |
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
az iot du instance update
Uppdatera en enhetsuppdateringsinstans.
För närvarande kan följande instansegenskaper uppdateras – iotHubs, enableDiagnostics, diagnosticStorageProperties och taggar.
az iot du instance update --account
--instance
[--add]
[--force-string]
[--no-wait]
[--remove]
[--resource-group]
[--set]
Exempel
Ange ett specifikt instanstaggattribut.
az iot du instance update -n {account_name} -i {instance_name} --set tags.env='test'
Aktivera diagnostik och konfigurera ett lagringskonto för logginsamling.
az iot du instance update -n {account_name} -i {instance_name} --set enableDiagnostics=true diagnosticStorageProperties.resourceId={storage_account_resource_id}
Obligatoriska parametrar
Namn på enhetsuppdateringskonto. Du kan konfigurera standardkontonamnet med hjälp av az config set defaults.adu_account={name}.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Account Identifier Arguments |
Namnet på enhetsuppdateringsinstansen. Du kan konfigurera standardinstansnamnet med hjälp av az config set defaults.adu_instance={name}.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Account Identifier Arguments |
Valfria parametrar
Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.
Lägg till ett objekt i en lista över objekt genom att ange en sökväg och nyckelvärdepar. Exempel: --add property.listProperty <key=value, string or JSON string>.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Generic Update Arguments |
| Standardvärde: | [] |
När du använder "set" eller "add" bevarar du strängliteraler i stället för att försöka konvertera till JSON.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Generic Update Arguments |
| Standardvärde: | False |
Vänta inte tills den långvariga åtgärden har slutförts.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Ta bort en egenskap eller ett element från en lista. Exempel: --remove property.list <indexToRemove> ELLER --remove propertyToRemove.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Generic Update Arguments |
| Standardvärde: | [] |
Namn på resursgrupp för enhetsuppdateringskonto. Du kan konfigurera standardgruppen med hjälp av az config set defaults.adu_group={name}.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Account Identifier Arguments |
Uppdatera ett objekt genom att ange en egenskapssökväg och ett värde som ska anges. Exempel: --set property1.property2=<value>.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Generic Update Arguments |
| Standardvärde: | [] |
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
az iot du instance wait
Blockera tills ett önskat instansresurstillstånd har uppfyllts.
az iot du instance wait --account
--instance
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--resource-group]
[--timeout]
[--updated]
Exempel
Blockera tills målinstansen har tagits bort.
az iot du instance wait -n {account_name} -i {instance_name} --deleted
Obligatoriska parametrar
Namn på enhetsuppdateringskonto. Du kan konfigurera standardkontonamnet med hjälp av az config set defaults.adu_account={name}.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Account Identifier Arguments |
Namnet på enhetsuppdateringsinstansen. Du kan konfigurera standardinstansnamnet med hjälp av az config set defaults.adu_instance={name}.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Account Identifier Arguments |
Valfria parametrar
Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.
Vänta tills du har skapat med "provisioningState" på "Lyckades".
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Wait Condition Arguments |
| Standardvärde: | False |
Vänta tills villkoret uppfyller en anpassad JMESPath-fråga. T.ex. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Wait Condition Arguments |
Vänta tills den har tagits bort.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Wait Condition Arguments |
| Standardvärde: | False |
Vänta tills resursen finns.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Wait Condition Arguments |
| Standardvärde: | False |
Avsökningsintervall i sekunder.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Wait Condition Arguments |
| Standardvärde: | 30 |
Namn på resursgrupp för enhetsuppdateringskonto. Du kan konfigurera standardgruppen med hjälp av az config set defaults.adu_group={name}.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Account Identifier Arguments |
Maximal väntetid i sekunder.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Wait Condition Arguments |
| Standardvärde: | 3600 |
Vänta tills det har uppdaterats med provisioningState på Lyckades.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Wait Condition Arguments |
| Standardvärde: | False |
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |