az iot hub module-identity

Referenz

Hinweis

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

Verwalten von IoT-Gerätemodulen.

Befehle

Name	Beschreibung	Typ	Status
az iot hub module-identity connection-string	Verwalten sie die Verbindungszeichenfolge des IoT-Gerätemoduls.	Erweiterung	GA
az iot hub module-identity connection-string show	Anzeigen eines Ziel-IoT-Gerätemoduls Verbindungszeichenfolge.	Erweiterung	GA
az iot hub module-identity create	Erstellen Sie ein Modul auf einem IoT-Zielgerät in einem IoT-Hub.	Erweiterung	GA
az iot hub module-identity delete	Löschen eines Geräts in einem IoT-Hub.	Erweiterung	GA
az iot hub module-identity list	Auflisten von Modulen auf einem IoT-Gerät in einem IoT-Hub.	Erweiterung	GA
az iot hub module-identity renew-key	Verlängern Sie Zielschlüssel von IoT Hub-Gerätemodulen mit sas-Authentifizierung.	Erweiterung	GA
az iot hub module-identity show	Rufen Sie die Details eines IoT-Gerätemoduls in einem IoT-Hub ab.	Erweiterung	GA
az iot hub module-identity update	Aktualisieren Sie ein IoT Hub-Gerätemodul.	Erweiterung	GA

az iot hub module-identity create

Erstellen Sie ein Modul auf einem IoT-Zielgerät in einem IoT-Hub.

Bei Verwendung der Authentifizierungsmethode von shared_private_key (auch als symmetrische Schlüssel bezeichnet) wird der Dienst für das Modul generiert, wenn keine benutzerdefinierten Schlüssel bereitgestellt werden.

az iot hub module-identity create --device-id
                                  --module-id
                                  [--am {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--hub-name]
                                  [--login]
                                  [--od]
                                  [--pk]
                                  [--primary-thumbprint]
                                  [--resource-group]
                                  [--secondary-key]
                                  [--secondary-thumbprint]
                                  [--valid-days]

Erforderliche Parameter

--device-id -d

Zielgeräte-ID.

--module-id -m

Zielmodul-ID.

Optionale Parameter

--am --auth-method

Die Autorisierungsmethode, mit der eine Entität erstellt werden soll.

Zulässige Werte: shared_private_key, x509_ca, x509_thumbprint

Standardwert: shared_private_key

--auth-type

Gibt an, ob der Vorgang einen Richtlinienschlüssel automatisch ableiten oder die aktuelle Azure AD-Sitzung verwenden soll. Wenn der Authentifizierungstyp login ist und der Ressourcenhost bereitgestellt wird, wird die Ressourcensuche übersprungen, es sei denn, dies ist erforderlich. Sie können die Standardeinstellung mithilfe von az configure --defaults iothub-data-auth-type={auth-type-value}.

Zulässige Werte: key, login

Standardwert: key

--hub-name -n

IoT Hub-Name oder Hostname. Erforderlich, wenn --login nicht angegeben wird.

--login -l

Dieser Befehl unterstützt eine Entität Verbindungszeichenfolge mit Rechten zum Ausführen von Aktionen. Wird verwendet, um die Sitzungsanmeldung über "az login" zu vermeiden. Wenn sowohl eine Entität Verbindungszeichenfolge als auch ein Name angegeben werden, hat die Verbindungszeichenfolge Vorrang. Erforderlich, wenn --hub-name nicht angegeben wird.

--od --output-dir

Generieren Sie selbstsignierte Zertifikate, und verwenden Sie den Fingerabdruck. Ausgabe in angegebenes Zielverzeichnis.

--pk --primary-key

Der primäre symmetrische gemeinsam genutzte Zugriffsschlüssel, der im Base64-Format gespeichert ist.

--primary-thumbprint --ptp

Selbstsignierter Zertifikatfingerabdruck, der für den primären Fingerabdruck verwendet werden soll.

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--secondary-key --sk

Der sekundäre symmetrische gemeinsam genutzte Zugriffsschlüssel, der im Base64-Format gespeichert ist.

--secondary-thumbprint --stp

Selbstsignierter Zertifikatfingerabdruck, der für den sekundären Fingerabdruck verwendet werden soll.

--valid-days --vd

Generieren Sie selbstsignierte Zertifikate, und verwenden Sie den Fingerabdruck. Gültig für die angegebene Anzahl von Tagen. Standard: 365.

Globale Parameter

--debug

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

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, 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

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.

az iot hub module-identity delete

Löschen eines Geräts in einem IoT-Hub.

az iot hub module-identity delete --device-id
                                  --module-id
                                  [--auth-type {key, login}]
                                  [--etag]
                                  [--hub-name]
                                  [--login]
                                  [--resource-group]

Erforderliche Parameter

--device-id -d

Zielgeräte-ID.

--module-id -m

Zielmodul-ID.

Optionale Parameter

--auth-type

Zulässige Werte: key, login

Standardwert: key

--etag -e

Etag oder Entitätstag, das dem letzten Status der Ressource entspricht. Wenn kein Etag angegeben wird, wird der Wert '*' verwendet.

--hub-name -n

IoT Hub-Name oder Hostname. Erforderlich, wenn --login nicht angegeben wird.

--login -l

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

Globale Parameter

--debug

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

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, 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

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.

az iot hub module-identity list

Auflisten von Modulen auf einem IoT-Gerät in einem IoT-Hub.

az iot hub module-identity list --device-id
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--resource-group]
                                [--top]

Erforderliche Parameter

--device-id -d

Zielgeräte-ID.

Optionale Parameter

--auth-type

Zulässige Werte: key, login

Standardwert: key

--hub-name -n

IoT Hub-Name oder Hostname. Erforderlich, wenn --login nicht angegeben wird.

--login -l

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--top

Maximale Anzahl der zurückzugebenden Elemente. Verwenden Sie -1 für unbegrenzt.

Standardwert: 1000

Globale Parameter

--debug

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

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, 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

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.

az iot hub module-identity renew-key

Verlängern Sie Zielschlüssel von IoT Hub-Gerätemodulen mit sas-Authentifizierung.

Derzeit werden Etags und Schlüsseltyp swap für die Massenregenerierung von Schlüsseln nicht unterstützt. Die Massenregenerierung von Schlüsseln wird ein anderes Ausgabeformat als die Regeneration einzelner Module erhalten.

az iot hub module-identity renew-key --device-id
                                     --hub-name
                                     --key-type {both, primary, secondary, swap}
                                     --module-id
                                     [--auth-type {key, login}]
                                     [--etag]
                                     [--login]
                                     [--no-progress {false, true}]
                                     [--resource-group]

Beispiele

Verlängern Sie den Primärschlüssel.

az iot hub module-identity renew-key -m {module_name} -d {device_id} -n {iothub_name} --kt primary

Tauschen Sie die primären und sekundären Schlüssel aus.

az iot hub module-identity renew-key -m {module_name} -d {device_id} -n {iothub_name} --kt swap

Verlängern Sie den Sekundärschlüssel für zwei Module.

az iot hub module-identity renew-key -m {module_name} {module_name} -d {device_id} -n {iothub_name} --kt secondary

Verlängern Sie beide Schlüssel für alle Module auf dem Gerät.

az iot hub module-identity renew-key -m * -d {device_id} -n {iothub_name} --kt both

Erforderliche Parameter

--device-id -d

Zielgeräte-ID.

--hub-name -n

IoT Hub-Name oder Hostname. Erforderlich, wenn --login nicht angegeben wird.

--key-type --kt

Zielschlüsseltyp, der neu generiert werden soll.

Zulässige Werte: both, primary, secondary, swap

--module-id -m

Getrennte Leerzeichenliste der Zielmodul-IDs. Verwenden Sie * für alle Module.

Optionale Parameter

--auth-type

Zulässige Werte: key, login

Standardwert: key

--etag -e

Etag oder Entitätstag, das dem letzten Status der Ressource entspricht. Wenn kein Etag angegeben wird, wird der Wert '*' verwendet. Dieses Argument gilt nur für swap.

--login -l

--no-progress

Blenden Sie die Statusleiste für die Massenregenerierung von Schlüsseln aus.

Zulässige Werte: false, true

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

Globale Parameter

--debug

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

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, 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

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.

az iot hub module-identity show

Rufen Sie die Details eines IoT-Gerätemoduls in einem IoT-Hub ab.

az iot hub module-identity show --device-id
                                --module-id
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--resource-group]

Erforderliche Parameter

--device-id -d

Zielgeräte-ID.

--module-id -m

Zielmodul-ID.

Optionale Parameter

--auth-type

Zulässige Werte: key, login

Standardwert: key

--hub-name -n

IoT Hub-Name oder Hostname. Erforderlich, wenn --login nicht angegeben wird.

--login -l

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

Globale Parameter

--debug

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

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, 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

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.

az iot hub module-identity update

Aktualisieren Sie ein IoT Hub-Gerätemodul.

Verwenden Sie --set gefolgt von Eigenschaftszuweisungen zum Aktualisieren eines Moduls. Nutzen Sie eigenschaften, die von "iot hub module-identity show" zurückgegeben werden.

az iot hub module-identity update --device-id
                                  --module-id
                                  [--add]
                                  [--auth-type {key, login}]
                                  [--etag]
                                  [--force-string]
                                  [--hub-name]
                                  [--login]
                                  [--remove]
                                  [--resource-group]
                                  [--set]

Beispiele

Generieren von symmetrischen Authentifizierungsschlüsseln für Module

az iot hub module-identity update -m {module_name} -d {device_id} -n {iothub_name} --set authentication.symmetricKey.primaryKey="" authentication.symmetricKey.secondaryKey=""

Erforderliche Parameter

--device-id -d

Zielgeräte-ID.

--module-id -m

Zielmodul-ID.

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: []

--auth-type

Zulässige Werte: key, login

Standardwert: key

--etag -e

Etag oder Entitätstag, das dem letzten Status der Ressource entspricht. Wenn kein Etag angegeben wird, wird der Wert '*' verwendet.

--force-string

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

Standardwert: False

--hub-name -n

IoT Hub-Name oder Hostname. Erforderlich, wenn --login nicht angegeben wird.

--login -l

--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 Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults 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

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

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, 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

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.

Freigeben über

az iot hub module-identity

Befehle

az iot hub module-identity create

Erforderliche Parameter

Optionale Parameter

az iot hub module-identity delete

Erforderliche Parameter

Optionale Parameter

az iot hub module-identity list

Erforderliche Parameter

Optionale Parameter

az iot hub module-identity renew-key

Beispiele

Erforderliche Parameter

Optionale Parameter

az iot hub module-identity show

Erforderliche Parameter

Optionale Parameter

az iot hub module-identity update

Beispiele

Erforderliche Parameter

Optionale Parameter

Zusätzliche Ressourcen