Freigeben über

az iot du device group

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 Gerätegruppe Befehl ausführen. Erfahren Sie mehr über Erweiterungen.

Gerätegruppenverwaltung.

Bei einer Gerätegruppe handelt es sich um eine Sammlung verwandter Geräte. Gerätegruppen bieten eine Möglichkeit zum Skalieren von Bereitstellungen auf viele Geräten. Jedes Gerät gehört jeweils zu genau einer Gerätegruppe. Eine Gerätegruppe wird automatisch erstellt, wenn ein Geräteupdate-fähiges Gerät mit dem Hub verbunden ist, und meldet dessen Eigenschaften.

Befehle

Name Beschreibung Typ Status
az iot du device group delete

Löschen sie eine Gerätegruppe.

 Extension GA
az iot du device group list

Auflisten von Gerätegruppen innerhalb einer Instanz.

 Extension GA
az iot du device group show

Zeigen Sie Details zu einer Gerätegruppe an, einschließlich der besten Update- und Updatecompliance.

 Extension GA

az iot du device group delete

Löschen sie eine Gerätegruppe.

Gerätegruppen werden nicht automatisch bereinigt, sondern für Verlaufszwecke aufbewahrt. Dieser Vorgang kann verwendet werden, wenn die Gruppe nicht benötigt wird oder der Verlauf beibehalten werden muss. Wenn ein Gerät jemals erneut für eine Gruppe verbunden ist, nachdem die Gruppe gelöscht wurde, wird es automatisch ohne Verlauf neu erstellt.

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

Beispiele

Löschen sie eine Gerätegruppe.

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

Löschen Sie eine Gerätegruppe, die die Bestätigungsaufforderung überspringt.

az iot du device group delete -n {account_name} -i {instance_name} --group-id {device_group_id} -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
--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.

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

Auflisten von Gerätegruppen innerhalb einer Instanz.

az iot du device group list --account
                            --instance
                            [--order-by]
                            [--resource-group]

Beispiele

Gerätegruppen auflisten.

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

Auflisten von Gerätegruppen in einer gewünschten Reihenfolge, in diesem Fall nach deviceCount.

az iot du device group list -n {account_name} -i {instance_name} --order-by deviceCount

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.

--order-by

Sortiert die Gruppe der zurückgegebenen Gruppen. Sie können nach "groupId", "deviceCount", "createdDateTime", "subgroupsWithNewUpdatesAvailableCount", "subgroupsWithUpdatesInProgressCount" oder "subgroupsWithOnLatestUpdateCount" sortieren.

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

Zeigen Sie Details zu einer Gerätegruppe an, einschließlich der besten Update- und Updatecompliance.

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

Beispiele

Anzeigen einer Gerätegruppe.

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

Zeigen Sie die besten Updates an, die für eine Gerätegruppe verfügbar sind. Mit diesem Flag wird der Befehl so geändert, dass eine Liste zurückgegeben wird.

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

Aktualisierungscompliance für eine Gerätegruppe anzeigen.

az iot du device group show -n {account_name} -i {instance_name} --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}konfigurieren.

Eigenschaft Wert
Parametergruppe: Account Identifier Arguments
--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.

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

--best-updates

Flag, das angibt, dass der Befehl die besten verfügbaren Updates für die Gerätegruppe abrufen sollte, einschließlich der Anzahl der Geräte, die jedes Update benötigen. Ein optimales Update ist das neueste Update, das alle Kompatibilitätsspezifikationen einer Geräteklasse erfüllt.

Eigenschaft Wert
Parametergruppe: Update Arguments
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.

Eigenschaft Wert
Parametergruppe: Account Identifier Arguments
--update-compliance

Flag, das angibt, dass der Befehl Gerätegruppenaktualisierungscomplianceinformationen abrufen soll, z. B. wie viele Geräte auf ihrem neuesten Update sind, wie viele neue Updates benötigen und wie viele beim Empfang eines neuen Updates ausgeführt werden.

Eigenschaft Wert
Parametergruppe: Update Arguments
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