Share via

az iot du instance

  • Referenz

Hinweis

Diese Referenz ist Teil der Azure-iot-Erweiterung für die Azure CLI (Version 2.37.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen az iot du instance-Befehl zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen

Geräteaktualisierungsinstanzverwaltung.

Befehle

Name Beschreibung Typ Status
az iot du instance create

Erstellen Sie eine Geräteaktualisierungsinstanz.

 Erweiterung Allgemein verfügbar
az iot du instance delete

Löschen einer Geräteaktualisierungsinstanz.

 Erweiterung Allgemein verfügbar
az iot du instance list

Geräteaktualisierungsinstanzen auflisten.

 Erweiterung Allgemein verfügbar
az iot du instance show

Anzeigen einer Geräteaktualisierungsinstanz.

 Erweiterung Allgemein verfügbar
az iot du instance update

Aktualisieren einer Geräteaktualisierungsinstanz.

 Erweiterung Allgemein verfügbar
az iot du instance wait

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

 Erweiterung Allgemein verfügbar

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 Diagnose aktiviert, 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>.

--instance -i

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

--iothub-ids

Durch Leerzeichen getrennte IoT Hub-Ressourcen-IDs.

Optionale Parameter

--diagnostics-storage-id

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

--enable-diagnostics

Aktiviert die Sammlung von Diagnoseprotokollen.

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

Nicht auf den Abschluss lang andauernder Vorgänge warten

Standardwert: False
--resource-group -g

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

--tags

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

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

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>.

--instance -i

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

Optionale Parameter

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

Standardwert: False
--resource-group -g

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

--yes -y

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

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

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

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>.

Optionale Parameter

--resource-group -g

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

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

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>.

--instance -i

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

Optionale Parameter

--resource-group -g

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

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

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 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>.

--instance -i

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

Optionale Parameter

--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>.

Standardwert: []
--force-string

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

Standardwert: False
--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

Standardwert: False
--remove

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

Standardwert: []
--resource-group -g

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

--set

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

Standardwert: []
Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

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>.

--instance -i

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

Optionale Parameter

--created

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

Standardwert: False
--custom

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

--deleted

Warten Sie, bis sie gelöscht wurde.

Standardwert: False
--exists

Warten Sie, bis die Ressource vorhanden ist.

Standardwert: False
--interval

Abrufintervall in Sekunden.

Standardwert: 30
--resource-group -g

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

--timeout

Maximale Wartezeit in Sekunden.

Standardwert: 3600
--updated

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

Standardwert: False
Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.