Freigeben über

az iot du instance

Note

Diese Referenz ist Teil der Azure-iot-Erweiterung für die Azure CLI (Version 2.67.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie ein az iot du instance Befehl ausführen. Erfahren Sie mehr über Erweiterungen.

Geräteaktualisierungsinstanzverwaltung.

Befehle

Name Beschreibung Typ Status
az iot du instance create

Erstellen Sie eine Geräteaktualisierungsinstanz.

 Extension GA
az iot du instance delete

Löschen einer Geräteaktualisierungsinstanz.

 Extension GA
az iot du instance list

Geräteaktualisierungsinstanzen auflisten.

 Extension GA
az iot du instance show

Anzeigen einer Geräteaktualisierungsinstanz.

 Extension GA
az iot du instance update

Aktualisieren einer Geräteaktualisierungsinstanz.

 Extension GA
az iot du instance wait

Blockieren, bis ein gewünschter Instanzressourcenstatus erfüllt wurde.

 Extension GA

az iot du instance create

Erstellen Sie eine Geräteaktualisierungsinstanz.

Dieser Befehl kann auch verwendet werden, um den Status einer vorhandenen Instanz zu aktualisieren.

az iot du instance create --account
                          --instance
                          --iothub-ids
                          [--diagnostics-storage-id]
                          [--enable-diagnostics {false, true}]
                          [--no-wait]
                          [--resource-group]
                          [--tags]

Beispiele

Erstellen Sie eine Instanz mit minimaler Konfiguration.

az iot du instance create -n {account_name} -i {instance_name} --iothub-ids {iothub_resource_id}

Erstellen Sie eine Instanz mit aktivierter Diagnose, gepaart mit einem vom Benutzer bereitgestellten Speicherkonto. Tags einschließen.

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

Erforderliche Parameter

--account -n

Name des Geräteaktualisierungskontos. Sie können den Standardkontonamen mithilfe von az config set defaults.adu_account={name}konfigurieren.

Eigenschaft Wert
Parametergruppe: Account Identifier Arguments
--instance -i

Name der Geräteaktualisierungsinstanz. Sie können den Standardinstanznamen mithilfe von az config set defaults.adu_instance={name}konfigurieren.

Eigenschaft Wert
Parametergruppe: Account Identifier Arguments
--iothub-ids

Durch Leerzeichen getrennte IoT Hub-Ressourcen-IDs.

Eigenschaft Wert
Parametergruppe: IoT Hub Arguments

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--diagnostics-storage-id

Vom Benutzer bereitgestellte Speicherkontoressourcen-ID für die Verwendung in der Diagnoseprotokollsammlung.

Eigenschaft Wert
Parametergruppe: Storage Arguments
--enable-diagnostics

Aktiviert die Sammlung von Diagnoseprotokollen.

Eigenschaft Wert
Zulässige Werte: false, true
--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

Eigenschaft Wert
Standardwert: False
--resource-group -g

Name der Geräteaktualisierungskontoressourcengruppe. Sie können die Standardgruppe mit az config set defaults.adu_group={name}konfigurieren.

Eigenschaft Wert
Parametergruppe: Account Identifier Arguments
--tags

Ressourcentags. Eigenschaftenbehälter in Schlüsselwertpaaren mit dem folgenden Format: a=b c=d.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az iot du instance delete

Löschen einer Geräteaktualisierungsinstanz.

az iot du instance delete --account
                          --instance
                          [--no-wait]
                          [--resource-group]
                          [--yes {false, true}]

Beispiele

Löschen Sie eine Instanz, die dem Zielkonto zugeordnet ist.

az iot du instance delete -n {account_name} -i {instance_name}

Löschen Sie eine Instanz, die dem Zielkonto zugeordnet ist, und überspringen Sie die Bestätigungsaufforderung.

az iot du instance delete -n {account_name} -i {instance_name} -y

Erforderliche Parameter

--account -n

Name des Geräteaktualisierungskontos. Sie können den Standardkontonamen mithilfe von az config set defaults.adu_account={name}konfigurieren.

Eigenschaft Wert
Parametergruppe: Account Identifier Arguments
--instance -i

Name der Geräteaktualisierungsinstanz. Sie können den Standardinstanznamen mithilfe von az config set defaults.adu_instance={name}konfigurieren.

Eigenschaft Wert
Parametergruppe: Account Identifier Arguments

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

Eigenschaft Wert
Standardwert: False
--resource-group -g

Name der Geräteaktualisierungskontoressourcengruppe. Sie können die Standardgruppe mit az config set defaults.adu_group={name}konfigurieren.

Eigenschaft Wert
Parametergruppe: Account Identifier Arguments
--yes -y

Benutzeraufforderungen überspringen. Gibt die Annahme der Aktion an. Wird hauptsächlich für Automatisierungsszenarien verwendet. Standardwert: false.

Eigenschaft Wert
Zulässige Werte: false, true
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az iot du instance list

Geräteaktualisierungsinstanzen auflisten.

az iot du instance list --account
                        [--resource-group]

Beispiele

Listet Instanzen auf, die dem Zielkonto zugeordnet sind.

az iot du instance list -n {account_name}

Erforderliche Parameter

--account -n

Name des Geräteaktualisierungskontos. Sie können den Standardkontonamen mithilfe von az config set defaults.adu_account={name}konfigurieren.

Eigenschaft Wert
Parametergruppe: Account Identifier Arguments

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--resource-group -g

Name der Geräteaktualisierungskontoressourcengruppe. Sie können die Standardgruppe mit az config set defaults.adu_group={name}konfigurieren.

Eigenschaft Wert
Parametergruppe: Account Identifier Arguments
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az iot du instance show

Anzeigen einer Geräteaktualisierungsinstanz.

az iot du instance show --account
                        --instance
                        [--resource-group]

Beispiele

Zeigen Sie die Details einer Instanz an, die dem Zielkonto zugeordnet ist.

az iot du instance show -n {account_name} -i {instance_name}

Erforderliche Parameter

--account -n

Name des Geräteaktualisierungskontos. Sie können den Standardkontonamen mithilfe von az config set defaults.adu_account={name}konfigurieren.

Eigenschaft Wert
Parametergruppe: Account Identifier Arguments
--instance -i

Name der Geräteaktualisierungsinstanz. Sie können den Standardinstanznamen mithilfe von az config set defaults.adu_instance={name}konfigurieren.

Eigenschaft Wert
Parametergruppe: Account Identifier Arguments

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--resource-group -g

Name der Geräteaktualisierungskontoressourcengruppe. Sie können die Standardgruppe mit az config set defaults.adu_group={name}konfigurieren.

Eigenschaft Wert
Parametergruppe: Account Identifier Arguments
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az iot du instance update

Aktualisieren einer Geräteaktualisierungsinstanz.

Derzeit können die folgenden Instanzeigenschaften aktualisiert werden – iotHubs, enableDiagnostics, diagnosticStorageProperties und Tags.

az iot du instance update --account
                          --instance
                          [--add]
                          [--force-string]
                          [--no-wait]
                          [--remove]
                          [--resource-group]
                          [--set]

Beispiele

Legen Sie ein bestimmtes Instanztag-Attribut fest.

az iot du instance update -n {account_name} -i {instance_name} --set tags.env='test'

Aktivieren Sie die Diagnose, und konfigurieren Sie ein Speicherkonto für die Protokollsammlung.

az iot du instance update -n {account_name} -i {instance_name} --set enableDiagnostics=true diagnosticStorageProperties.resourceId={storage_account_resource_id}

Erforderliche Parameter

--account -n

Name des Geräteaktualisierungskontos. Sie können den Standardkontonamen mithilfe von az config set defaults.adu_account={name}konfigurieren.

Eigenschaft Wert
Parametergruppe: Account Identifier Arguments
--instance -i

Name der Geräteaktualisierungsinstanz. Sie können den Standardinstanznamen mithilfe von az config set defaults.adu_instance={name}konfigurieren.

Eigenschaft Wert
Parametergruppe: Account Identifier Arguments

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--add

Fügen Sie einer Liste von Objekten ein Objekt hinzu, indem Sie ein Pfad- und Schlüsselwertpaar angeben. Beispiel: --add property.listProperty <key=value, string or JSON string>.

Eigenschaft Wert
Parametergruppe: Generic Update Arguments
Standardwert: []
--force-string

Wenn Sie "set" oder "add" verwenden, behalten Sie Zeichenfolgenliterale bei, anstatt zu versuchen, in JSON zu konvertieren.

Eigenschaft Wert
Parametergruppe: Generic Update Arguments
Standardwert: False
--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

Eigenschaft Wert
Standardwert: False
--remove

Entfernen sie eine Eigenschaft oder ein Element aus einer Liste. Beispiel: --remove property.list <indexToRemove> ODER --remove propertyToRemove.

Eigenschaft Wert
Parametergruppe: Generic Update Arguments
Standardwert: []
--resource-group -g

Name der Geräteaktualisierungskontoressourcengruppe. Sie können die Standardgruppe mit az config set defaults.adu_group={name}konfigurieren.

Eigenschaft Wert
Parametergruppe: Account Identifier Arguments
--set

Aktualisieren Sie ein Objekt, indem Sie einen festzulegenden Eigenschaftspfad und -wert angeben. Beispiel: --set property1.property2=<value>.

Eigenschaft Wert
Parametergruppe: Generic Update Arguments
Standardwert: []
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az iot du instance wait

Blockieren, bis ein gewünschter Instanzressourcenstatus erfüllt wurde.

az iot du instance wait --account
                        --instance
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--interval]
                        [--resource-group]
                        [--timeout]
                        [--updated]

Beispiele

Blockieren, bis die Zielinstanz gelöscht wurde.

az iot du instance wait -n {account_name} -i {instance_name} --deleted

Erforderliche Parameter

--account -n

Name des Geräteaktualisierungskontos. Sie können den Standardkontonamen mithilfe von az config set defaults.adu_account={name}konfigurieren.

Eigenschaft Wert
Parametergruppe: Account Identifier Arguments
--instance -i

Name der Geräteaktualisierungsinstanz. Sie können den Standardinstanznamen mithilfe von az config set defaults.adu_instance={name}konfigurieren.

Eigenschaft Wert
Parametergruppe: Account Identifier Arguments

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--created

Warten Sie, bis sie mit 'provisioningState' unter 'Succeeded' erstellt wurde.

Eigenschaft Wert
Parametergruppe: Wait Condition Arguments
Standardwert: False
--custom

Warten Sie, bis die Bedingung eine benutzerdefinierte JMESPath-Abfrage erfüllt. Beispiel: provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Eigenschaft Wert
Parametergruppe: Wait Condition Arguments
--deleted

Warten Sie, bis sie gelöscht wurde.

Eigenschaft Wert
Parametergruppe: Wait Condition Arguments
Standardwert: False
--exists

Warten Sie, bis die Ressource vorhanden ist.

Eigenschaft Wert
Parametergruppe: Wait Condition Arguments
Standardwert: False
--interval

Abrufintervall in Sekunden.

Eigenschaft Wert
Parametergruppe: Wait Condition Arguments
Standardwert: 30
--resource-group -g

Name der Geräteaktualisierungskontoressourcengruppe. Sie können die Standardgruppe mit az config set defaults.adu_group={name}konfigurieren.

Eigenschaft Wert
Parametergruppe: Account Identifier Arguments
--timeout

Maximale Wartezeit in Sekunden.

Eigenschaft Wert
Parametergruppe: Wait Condition Arguments
Standardwert: 3600
--updated

Warten Sie, bis sie mit provisioningState unter 'Succeeded' aktualisiert wurde.

Eigenschaft Wert
Parametergruppe: Wait Condition Arguments
Standardwert: False
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False