az iot central 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 central device-group Befehl ausführen. Erfahren Sie mehr über Erweiterungen.

Verwalten und Konfigurieren von IoT Central-Gerätegruppen.

Befehle

Name Beschreibung Typ Status
az iot central device-group create

Erstellen einer Gerätegruppe.

 Extension GA
az iot central device-group delete

Löschen sie eine Gerätegruppe.

 Extension GA
az iot central device-group list

Ruft die Liste der Gerätegruppen für eine IoT Central-Anwendung ab.

 Extension GA
az iot central device-group show

Rufen Sie die Gerätegruppe nach ID ab.

 Extension GA
az iot central device-group update

Aktualisieren sie eine vorhandene Gerätegruppe.

 Extension GA

az iot central device-group create

Erstellen einer Gerätegruppe.

Hinweis: Nur eine Organisation wird heute unterstützt, mehrere Organisationen werden in Kürze unterstützt.

az iot central device-group create --app-id
                                   --device-group-id
                                   --display-name
                                   --filter
                                   [--acquire-policy-token]
                                   [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                   [--central-api-uri --central-dns-suffix]
                                   [--change-reference]
                                   [--description]
                                   [--organizations]
                                   [--token]

Beispiele

Erstellen einer Gerätegruppe.

az iot central device-group create --app-id {appid} --device-group-id {devicegroupid} --display-name "DeviceGroup1" --filter "SELECT * FROM devices WHERE $provisioned = true" --description "This is a default device group." --organizations {organization}

Erforderliche Parameter

--app-id -n

Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.

--device-group-id

Eindeutige ID der Gerätegruppe.

--display-name

Anzeigename der Gerätegruppe.

--filter

Abfrage, die definiert, welche Geräte in dieser Gruppe enthalten sein sollen. [Abfragefilterbeispiel: SELECT * FROM Devices WHERE $template = "dtmi:modelDefinition:dtdlv2"].

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.

--acquire-policy-token

Automatisches Abrufen eines Azure Policy Tokens für diesen Ressourcenvorgang.

Eigenschaft Wert
Parametergruppe: Global Policy Arguments
--api-version --av
Als veraltet markiert

Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.

Dieser Befehlsparameter ist veraltet und wird ignoriert. In der zukünftigen Version werden wir nur IoT Central APIs von der neuesten GA-Version unterstützen. Wenn eine API noch nicht GA ist, rufen wir die neueste Vorschauversion auf.

Eigenschaft Wert
Standardwert: 2022-07-31
Zulässige Werte: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.

Eigenschaft Wert
Standardwert: azureiotcentral.com
--change-reference

Die zugehörige Änderungsreferenz-ID für diesen Ressourcenvorgang.

Eigenschaft Wert
Parametergruppe: Global Policy Arguments
--description

Kurze Zusammenfassung der Gerätegruppe.

--organizations

Liste der Organisations-IDs der Gerätegruppe.

--token

Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.

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 central device-group delete

Löschen sie eine Gerätegruppe.

az iot central device-group delete --app-id
                                   --device-group-id
                                   [--acquire-policy-token]
                                   [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                   [--central-api-uri --central-dns-suffix]
                                   [--change-reference]
                                   [--token]

Beispiele

Löschen einer Gerätegruppe

az iot central device-group delete --app-id {appid} --device-group-id {devicegroupid}

Erforderliche Parameter

--app-id -n

Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.

--device-group-id

Eindeutige ID der Gerätegruppe.

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.

--acquire-policy-token

Automatisches Abrufen eines Azure Policy Tokens für diesen Ressourcenvorgang.

Eigenschaft Wert
Parametergruppe: Global Policy Arguments
--api-version --av
Als veraltet markiert

Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.

Dieser Befehlsparameter ist veraltet und wird ignoriert. In der zukünftigen Version werden wir nur IoT Central APIs von der neuesten GA-Version unterstützen. Wenn eine API noch nicht GA ist, rufen wir die neueste Vorschauversion auf.

Eigenschaft Wert
Standardwert: 2022-07-31
Zulässige Werte: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.

Eigenschaft Wert
Standardwert: azureiotcentral.com
--change-reference

Die zugehörige Änderungsreferenz-ID für diesen Ressourcenvorgang.

Eigenschaft Wert
Parametergruppe: Global Policy Arguments
--token

Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.

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

Ruft die Liste der Gerätegruppen für eine IoT Central-Anwendung ab.

az iot central device-group list --app-id
                                 [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                 [--central-api-uri --central-dns-suffix]
                                 [--token]

Beispiele

Auflisten von Gerätegruppen in einer Anwendung

az iot central device-group list --app-id {appid}

Erforderliche Parameter

--app-id -n

Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.

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.

--api-version --av
Als veraltet markiert

Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.

Dieser Befehlsparameter ist veraltet und wird ignoriert. In der zukünftigen Version werden wir nur IoT Central APIs von der neuesten GA-Version unterstützen. Wenn eine API noch nicht GA ist, rufen wir die neueste Vorschauversion auf.

Eigenschaft Wert
Standardwert: 2022-07-31
Zulässige Werte: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.

Eigenschaft Wert
Standardwert: azureiotcentral.com
--token

Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.

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

Rufen Sie die Gerätegruppe nach ID ab.

az iot central device-group show --app-id
                                 --device-group-id
                                 [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                 [--central-api-uri --central-dns-suffix]
                                 [--token]

Beispiele

Rufen Sie die Gerätegruppe nach ID ab.

az iot central device-group show --app-id {appid} --device-group-id {devicegroupid}

Erforderliche Parameter

--app-id -n

Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.

--device-group-id

Eindeutige ID der Gerätegruppe.

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.

--api-version --av
Als veraltet markiert

Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.

Dieser Befehlsparameter ist veraltet und wird ignoriert. In der zukünftigen Version werden wir nur IoT Central APIs von der neuesten GA-Version unterstützen. Wenn eine API noch nicht GA ist, rufen wir die neueste Vorschauversion auf.

Eigenschaft Wert
Standardwert: 2022-07-31
Zulässige Werte: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.

Eigenschaft Wert
Standardwert: azureiotcentral.com
--token

Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.

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 central device-group update

Aktualisieren sie eine vorhandene Gerätegruppe.

Hinweis: Nur eine Organisation wird heute unterstützt, mehrere Organisationen werden in Kürze unterstützt.

az iot central device-group update --app-id
                                   --device-group-id
                                   [--acquire-policy-token]
                                   [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                   [--central-api-uri --central-dns-suffix]
                                   [--change-reference]
                                   [--description]
                                   [--display-name]
                                   [--filter]
                                   [--organizations]
                                   [--token]

Beispiele

Aktualisieren einer Gerätegruppe über Patch

az iot central device-group update --app-id {appid} --device-group-id {devicegroupid} --display-name {displayname} --filter {filter} --description {description} --organizations {organization}

Erforderliche Parameter

--app-id -n

Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.

--device-group-id

Eindeutige ID der Gerätegruppe.

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.

--acquire-policy-token

Automatisches Abrufen eines Azure Policy Tokens für diesen Ressourcenvorgang.

Eigenschaft Wert
Parametergruppe: Global Policy Arguments
--api-version --av
Als veraltet markiert

Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.

Dieser Befehlsparameter ist veraltet und wird ignoriert. In der zukünftigen Version werden wir nur IoT Central APIs von der neuesten GA-Version unterstützen. Wenn eine API noch nicht GA ist, rufen wir die neueste Vorschauversion auf.

Eigenschaft Wert
Standardwert: 2022-07-31
Zulässige Werte: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.

Eigenschaft Wert
Standardwert: azureiotcentral.com
--change-reference

Die zugehörige Änderungsreferenz-ID für diesen Ressourcenvorgang.

Eigenschaft Wert
Parametergruppe: Global Policy Arguments
--description

Kurze Zusammenfassung der Gerätegruppe.

--display-name

Anzeigename der Gerätegruppe.

--filter

Abfrage, die definiert, welche Geräte in dieser Gruppe enthalten sein sollen. [Abfragefilterbeispiel: SELECT * FROM Devices WHERE $template = "dtmi:modelDefinition:dtdlv2"].

--organizations

Liste der Organisations-IDs der Gerätegruppe.

--token

Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.

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