az iot du device class

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 Device Class-Befehl zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen

Geräteklasse und Geräteklassen-Untergruppenverwaltung.

Eine Geräteklasse beschreibt eine Gruppe von Geräten, die einen gemeinsamen Satz von Attributen über Gruppen hinweg gemeinsam nutzen, während eine Untergruppe einer Geräteklasse eine Teilmenge von Geräten in einer Gruppe ist, die dieselbe Geräteklassen-ID gemeinsam verwenden. Geräteklassen werden automatisch erstellt, wenn geräteupdatefähige Geräte mit dem Hub verbunden sind.

Befehle

Name Beschreibung Typ Status
az iot du device class delete

Löschen Einer Geräteklasse oder Geräteklassenuntergruppe.

Durchwahl Allgemein verfügbar
az iot du device class list

Auflisten von Geräteklassen oder Untergruppen der Geräteklasse.

Durchwahl Allgemein verfügbar
az iot du device class show

Zeigen Sie Details zu einer Untergruppe der Geräteklasse oder Geräteklasse an, einschließlich installierbarer Updates, der besten Update- und Updatecompliance.

Durchwahl Allgemein verfügbar
az iot du device class update

Aktualisieren sie eine Geräteklasse.

Durchwahl Allgemein verfügbar

az iot du device class delete

Löschen Einer Geräteklasse oder Geräteklassenuntergruppe.

Geräteklassen werden automatisch erstellt, wenn geräteupdatefähige Geräte mit dem Hub verbunden sind, aber nicht automatisch sauber werden, da sie von Untergruppen der Geräteklasse referenziert werden. Wenn alle Geräteklassenuntergruppen für eine Zielgeräteklasse gelöscht werden, kann die Geräteklasse selbst auch gelöscht werden, um die Datensätze aus dem System zu entfernen und die Kompatibilität der Geräteklasse mit neuen Updates zu beenden. Wenn ein Gerät jemals erneut verbunden wird, wird seine Geräteklasse erneut erstellt, wenn es nicht vorhanden ist.

az iot du device class delete --account
                              --cid
                              --instance
                              [--gid]
                              [--resource-group]
                              [--yes {false, true}]

Beispiele

Löschen sie eine Geräteklasse.

az iot du device class delete -n {account_name} -i {instance_name} --class-id {device_class_id}

Löschen Sie eine Geräteklasse, und überspringen Sie die Bestätigungsaufforderung.

az iot du device class delete -n {account_name} -i {instance_name} --class-id {device_class_id} -y

Löschen sie eine Untergruppe der Geräteklasse.

az iot du device class delete -n {account_name} -i {instance_name} --class-id {device_class_id} --group-id {device_group_id}

Erforderliche Parameter

--account -n

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

--cid --class-id

Geräteklassen-ID. Dies wird aus der Modell-ID und den compat-Eigenschaften generiert, die vom Geräteupdate-Agent in der Device Update PnP-Schnittstelle im IoT Hub gemeldet werden. Es handelt sich um einen hexcodierten SHA1-Hash.

--instance -i

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

Optionale Parameter

--gid --group-id

Gerätegruppen-ID. Dies wird aus dem Wert des ADUGroup-Tags im verbundenen IoT Hub-Gerät/Modul twin oder $default für Geräte ohne Tag erstellt.

--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 device class list

Auflisten von Geräteklassen oder Untergruppen der Geräteklasse.

az iot du device class list --account
                            --instance
                            [--filter]
                            [--gid]
                            [--resource-group]

Beispiele

Auflisten von Geräteklassen innerhalb einer Instanz.

az iot du device class list -n {account_name} -i {instance_name}

Listeninstanzgeräteklassen nach Anzeigenamen gefiltert.

az iot du device class list -n {account_name} -i {instance_name} --filter "friendlyName eq 'my-favorite-class'"

Auflisten von Geräteklassenuntergruppen für die Gruppe.

az iot du device class list -n {account_name} -i {instance_name} --group-id {device_group_id}

Auflisten von Geräteklassenuntergruppen für die Gruppe, gefiltert nach compatProperties/manufacturer.

az iot du device class list -n {account_name} -i {instance_name} --group-id {device_group_id} --filter "compatProperties/manufacturer eq 'Contoso'"

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

--filter

Wenn sie mit "--group-id" bereitgestellt werden, unterstützt die Filterung basierend auf Den Namen und Werten der Geräteklasse. Beispiel: "compatProperties/manufacturer eq 'Contoso'". Unterstützt andernfalls das Filtern nach Anzeigenamen der Klasse.

--gid --group-id

Gerätegruppen-ID. Dies wird aus dem Wert des ADUGroup-Tags im verbundenen IoT Hub-Gerät/Modul twin oder $default für Geräte ohne Tag erstellt.

--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 device class show

Zeigen Sie Details zu einer Untergruppe der Geräteklasse oder Geräteklasse an, einschließlich installierbarer Updates, der besten Update- und Updatecompliance.

az iot du device class show --account
                            --cid
                            --instance
                            [--best-update {false, true}]
                            [--gid]
                            [--installable-updates {false, true}]
                            [--resource-group]
                            [--update-compliance {false, true}]

Beispiele

Anzeigen einer Geräteklasse.

az iot du device class show -n {account_name} -i {instance_name} --class-id {device_class_id}

Zeigen Sie installierbare Updates für die Geräteklasse an. Mit diesem Flag wird der Befehl so geändert, dass eine Liste zurückgegeben wird.

az iot du device class show -n {account_name} -i {instance_name} --class-id {device_class_id} --installable-updates

Anzeigen einer Untergruppe der Geräteklasse.

az iot du device class show -n {account_name} -i {instance_name} --class-id {device_class_id} --group-id {device_group_id}

Zeigen Sie das beste Update an, das für eine Untergruppe der Geräteklasse verfügbar ist.

az iot du device class show -n {account_name} -i {instance_name} --class-id {device_class_id} --group-id {device_group_id} --best-update

Aktualisierungscompliance für eine Untergruppe der Geräteklasse anzeigen.

az iot du device class show -n {account_name} -i {instance_name} --class-id {device_class_id} --group-id {device_group_id} --update-compliance

Erforderliche Parameter

--account -n

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

--cid --class-id

Geräteklassen-ID. Dies wird aus der Modell-ID und den compat-Eigenschaften generiert, die vom Geräteupdate-Agent in der Device Update PnP-Schnittstelle im IoT Hub gemeldet werden. Es handelt sich um einen hexcodierten SHA1-Hash.

--instance -i

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

Optionale Parameter

--best-update

Flag, das angibt, dass der Befehl das beste verfügbare Update für die Untergruppe der Geräteklasse abrufen sollte, einschließlich der Anzahl der Geräte, die das Update benötigen. Die Gruppen-ID ist für dieses Flag erforderlich. Ein optimales Update ist das neueste Update, das alle Kompatibilitätsspezifikationen einer Geräteklasse erfüllt.

Zulässige Werte: false, true
--gid --group-id

Gerätegruppen-ID. Dies wird aus dem Wert des ADUGroup-Tags im verbundenen IoT Hub-Gerät/Modul twin oder $default für Geräte ohne Tag erstellt.

--installable-updates

Flag, das angibt, dass der Befehl installierbare Updates für die Geräteklasse abrufen soll.

Zulässige Werte: false, true
--resource-group -g

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

--update-compliance

Flag, das angibt, dass der Befehl Informationen zur Geräteklasse-Untergruppenaktualisierung abrufen soll, z. B. wie viele Geräte auf ihrem neuesten Update vorhanden sind, wie viele neue Updates benötigen und wie viele beim Empfang eines neuen Updates in Bearbeitung sind. Die Gruppen-ID ist für dieses Flag erforderlich.

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 device class update

Aktualisieren sie eine Geräteklasse.

az iot du device class update --account
                              --cid
                              --instance
                              [--friendly-name]
                              [--resource-group]

Beispiele

Aktualisieren Sie den Anzeigenamen der Geräteklasse.

az iot du device class update -n {account_name} -i {instance_name} --class-id {device_class_id} --friendly-name "EU-region"

Erforderliche Parameter

--account -n

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

--cid --class-id

Geräteklassen-ID. Dies wird aus der Modell-ID und den compat-Eigenschaften generiert, die vom Geräteupdate-Agent in der Device Update PnP-Schnittstelle im IoT Hub gemeldet werden. Es handelt sich um einen hexcodierten SHA1-Hash.

--instance -i

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

Optionale Parameter

--friendly-name

Der Anzeigename der Geräteklasse. Der Anzeigename muss 1 bis 100 Zeichen lang sein und unterstützt alphanumerische, Punkt- und Strichwerte.

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