az iot device

Referenz

Hinweis

Dieser Verweis ist Teil der Azure-iot-Erweiterung für die Azure CLI (Version 2.30.0 oder höher). Die Erweiterung wird beim ersten Ausführen eines Az iot-Gerätebefehls automatisch installiert. Weitere Informationen zu Erweiterungen

Nutzen Sie Gerätesimulationen und andere gerätezentrierte Vorgänge wie Geräte-to-Cloud- oder Cloud-to-Device-Messaging-Funktionen.

Befehle

az iot device c2d-message	Cloud-to-device Messaging-Befehle.
az iot device c2d-message abandon	Verlassen Sie eine Cloud-to-Device-Nachricht.
az iot device c2d-message complete	Schließen Sie eine Cloud-to-Device-Nachricht ab.
az iot device c2d-message purge	Löschen sie die Warteschlange für cloud-to-device-Nachrichten für ein Zielgerät.
az iot device c2d-message receive	Erhalten Sie eine Cloud-to-Device-Nachricht.
az iot device c2d-message reject	Ablehnen oder Totlettieren einer Cloud-zu-Gerät-Nachricht.
az iot device c2d-message send	Senden Sie eine Cloud-zu-Gerät-Nachricht.
az iot device registration	Verwalten von IoT-Geräteregistrierungen für den IoT-Gerätebereitstellungsdienst.
az iot device registration create	Registrieren Eines IoT-Geräts mit dem IoT-Gerätebereitstellungsdienst.
az iot device send-d2c-message	Senden Sie eine mqtt-Geräte-an-Cloud-Nachricht. Der Befehl unterstützt das Senden von Nachrichten mit Anwendungs- und Systemeigenschaften. Hinweis: Wenn Sie x509-Authentifizierungsmethoden verwenden, müssen die Zertifikat- und Schlüsseldateien (und passphrase bei Bedarf) bereitgestellt werden.
az iot device simulate	Simuliert ein Gerät in einem Azure IoT Hub. Während die Gerätesimulation ausgeführt wird, empfängt das Gerät automatisch Cloud-to-Device -Nachrichten (c2d). Für die Mqtt-Simulation werden alle c2d-Nachrichten mit Abschluss bestätigt. Für http Simulation c2d-Bestätigung basiert auf der Benutzerauswahl, die abgeschlossen, abgelehnt oder abgebrochen werden kann. Die Mqtt-Simulation unterstützt auch direkte Methodenberufe, die durch einen Antwortstatuscode und die Antwortlast anerkannt werden können. Hinweis: Der Befehl wird standardmäßig auf anwendung/json und inhaltscodierung auf utf-8 festgelegt. Dies kann außer Kraft gesetzt werden. Hinweis: Wenn Sie x509-Authentifizierungsmethoden verwenden, müssen die Zertifikat- und Schlüsseldateien (und passphrase bei Bedarf) bereitgestellt werden.
az iot device upload-file	Laden Sie eine lokale Datei als Gerät in einen vorab konfigurierten Blobspeichercontainer hoch.

az iot device send-d2c-message

Senden Sie eine mqtt-Geräte-an-Cloud-Nachricht. Der Befehl unterstützt das Senden von Nachrichten mit Anwendungs- und Systemeigenschaften. Hinweis: Wenn Sie x509-Authentifizierungsmethoden verwenden, müssen die Zertifikat- und Schlüsseldateien (und passphrase bei Bedarf) bereitgestellt werden.

az iot device send-d2c-message --device-id
                               [--certificate-file-path]
                               [--da]
                               [--dtmi]
                               [--hub-name]
                               [--key]
                               [--key-file-path]
                               [--login]
                               [--mc]
                               [--pass]
                               [--properties]
                               [--resource-group]

Beispiele

Grundlegende Verwendung

az iot device send-d2c-message -n {iothub_name} -d {device_id}

Grundlegende Verwendung für das Registrieren der Modell-ID von 'dtmi:com:example:Thermostat;1' nach Verbindung

az iot device send-d2c-message -n {iothub_name} -d {device_id} --model-id 'dtmi:com:example:Thermostat;1'

Grundlegende Verwendung für Geräte mit x509-Authentifizierung

az iot device send-d2c-message -n {iothub_name} -d {device_id} --cp {certificate_file_path} --kp {key_file_path}

Grundlegende Verwendung für Geräte mit x509-Authentifizierung, in der die Schlüsseldatei über eine Passphrase verfügt

az iot device send-d2c-message -n {iothub_name} -d {device_id} --cp {certificate_file_path} --kp {key_file_path} --pass {passphrase}

Grundlegende Verwendung mit benutzerdefinierten Daten

az iot device send-d2c-message -n {iothub_name} -d {device_id} --data {message_body}

Anwendungseigenschaften senden

az iot device send-d2c-message -n {iothub_name} -d {device_id} --props 'key0=value0;key1=value1'

Systemeigenschaften senden (Nachrichten-ID und Korrelations-ID)

az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.mid=<id>;$.cid=<id>'

Erforderliche Parameter

--device-id -d

Zielgerät.

Optionale Parameter

--certificate-file-path --cp

Pfad zur Zertifikatdatei.

--da --data

Nachrichtentext.

Standardwert: Ping from Az CLI IoT Extension

--dtmi --model-id

Die Digital Twin Model ID wird beim Herstellen einer Verbindung mit dem Hub angezeigt. Weitere Informationen finden Sie unter https://docs.microsoft.com/en-us/azure/iot-develop/overview-iot-plug-and-play.

--hub-name -n

IoT Hub Name. Erforderlich, wenn die Anmeldung nicht bereitgestellt wird.

--key --symmetric-key

Symmetrischer Schlüssel, der für das Gerät verwendet werden soll. Wenn die symmetrischen Schlüssel und andere Geräteauthentifizierungsargumente bereitgestellt werden, nimmt symmetrischer Schlüssel Vorrang.

--key-file-path --kp

Pfad zur Schlüsseldatei.

--login -l

Dieser Befehl unterstützt eine Entitätsverbindungszeichenfolge mit Rechten zum Ausführen von Aktionen. Verwenden Sie die Verwendung, um die Sitzungsanmeldung über "az login" zu vermeiden. Wenn sowohl eine Entitätsverbindungszeichenfolge als auch ein Name bereitgestellt werden, wird die Verbindungszeichenfolge vorrangig verwendet. Erforderlich, wenn --hub-name nicht bereitgestellt wird.

--mc --msg-count

Anzahl der Gerätenachrichten, die an IoT Hub gesendet werden sollen.

Standardwert: 1

--pass --passphrase

Passphrase für die Schlüsseldatei.

--properties --props -p

--resource-group -g

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

--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 device simulate

Simuliert ein Gerät in einem Azure IoT Hub. Während die Gerätesimulation ausgeführt wird, empfängt das Gerät automatisch Cloud-to-Device -Nachrichten (c2d). Für die Mqtt-Simulation werden alle c2d-Nachrichten mit Abschluss bestätigt. Für http Simulation c2d-Bestätigung basiert auf der Benutzerauswahl, die abgeschlossen, abgelehnt oder abgebrochen werden kann. Die Mqtt-Simulation unterstützt auch direkte Methodenberufe, die durch einen Antwortstatuscode und die Antwortlast anerkannt werden können. Hinweis: Der Befehl wird standardmäßig auf anwendung/json und inhaltscodierung auf utf-8 festgelegt. Dies kann außer Kraft gesetzt werden. Hinweis: Wenn Sie x509-Authentifizierungsmethoden verwenden, müssen die Zertifikat- und Schlüsseldateien (und passphrase bei Bedarf) bereitgestellt werden.

az iot device simulate --device-id
                       [--certificate-file-path]
                       [--da]
                       [--dtmi]
                       [--hub-name]
                       [--init-reported-properties]
                       [--key]
                       [--key-file-path]
                       [--login]
                       [--mc]
                       [--method-response-code]
                       [--method-response-payload]
                       [--mi]
                       [--pass]
                       [--properties]
                       [--proto {http, mqtt}]
                       [--receive-settle {abandon, complete, reject}]
                       [--resource-group]

Beispiele

Grundlegende Verwendung (mqtt)

az iot device simulate -n {iothub_name} -d {device_id}

Grundlegende Verwendung für das Registrieren der Modell-ID von 'dtmi:com:example:Thermostat;1' nach Verbindung (mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --model-id 'dtmi:com:example:Thermostat;1'

Grundlegende Verwendung für Geräte mit x509-Authentifizierung (mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --cp {certificate_file_path} --kp {key_file_path}

Grundlegende Verwendung für Geräte mit x509-Authentifizierung (mqtt), in der die Schlüsseldatei über eine Passphrase verfügt

az iot device simulate -n {iothub_name} -d {device_id} --cp {certificate_file_path} --kp {key_file_path} --pass {passphrase}

Senden von gemischten Eigenschaften (mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --properties "myprop=myvalue;$.ct=application/json"

Senden von Direct-Method-Antwortstatuscode und direct method response payload as raw json (only mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --method-response-code 201 --method-response-payload '{"result":"Direct method successful"}'

Senden von Direct-Method-Antwortstatuscode und Direct-Methode-Antwort-Nutzlast als Pfad zu lokaler Datei (nur mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --method-response-code 201 --method-response-payload '../my_direct_method_payload.json'

Senden des anfänglichen Zustands von Geräte twin gemeldeten Eigenschaften als unformatierte JSON für das Zielgerät (nur mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --init-reported-properties '{"reported_prop_1":"val_1", "reported_prop_2":val_2}'

Senden des anfänglichen Zustands von Geräte twin gemeldeten Eigenschaften als Pfad zu lokaler Datei für das Zielgerät (nur mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --init-reported-properties '../my_device_twin_reported_properties.json'

Grundlegende Verwendung (http)

az iot device simulate -n {iothub_name} -d {device_id} --protocol http

Senden von gemischten Eigenschaften (http)

az iot device simulate -n {iothub_name} -d {device_id} --protocol http --properties "iothub-app-myprop=myvalue;content-type=application/json;iothub-correlationid=12345"

Gesamtzahl der Nachrichten und Intervalle zwischen Nachrichten auswählen

az iot device simulate -n {iothub_name} -d {device_id} --msg-count 1000 --msg-interval 5

Ablehnen von c2d-Nachrichten (nur http)

az iot device simulate -n {iothub_name} -d {device_id} --rs reject --protocol http

Verlassen von c2d-Nachrichten (nur http)

az iot device simulate -n {iothub_name} -d {device_id} --rs abandon --protocol http

Erforderliche Parameter

--device-id -d

Zielgerät.

Optionale Parameter

--certificate-file-path --cp

Pfad zur Zertifikatdatei.

--da --data

Nachrichtentext.

Standardwert: Ping from Az CLI IoT Extension

--dtmi --model-id

--hub-name -n

IoT Hub Name. Erforderlich, wenn die Anmeldung nicht bereitgestellt wird.

--init-reported-properties --irp

Anfänglicher Zustand von twin gemeldeten Eigenschaften für das Zielgerät, wenn der Simulator ausgeführt wird. Optionaler Param, nur für mqtt unterstützt.

--key --symmetric-key

--key-file-path --kp

Pfad zur Schlüsseldatei.

--login -l

--mc --msg-count

Anzahl der Gerätenachrichten, die an IoT Hub gesendet werden sollen.

Standardwert: 100

--method-response-code --mrc

Statuscode, der zurückgegeben werden soll, wenn die direkte Methode auf dem Gerät ausgeführt wird. Optionaler Param, nur für mqtt unterstützt.

--method-response-payload --mrp

Nutzlast, die zurückgegeben werden soll, wenn die direkte Methode auf dem Gerät ausgeführt wird. Geben Sie Dateipfad oder unformatierte JSON an. Optionaler Param, nur für mqtt unterstützt.

--mi --msg-interval

Verzögerung in Sekunden zwischen Geräte-zu-Cloud-Nachrichten.

Standardwert: 3

--pass --passphrase

Passphrase für die Schlüsseldatei.

--properties --props -p

Nachrichteneigenschaftsbehälter in Schlüsselwertpaaren mit dem folgenden Format: a=b;c=d. Für mqtt-Messaging – Sie können Systemeigenschaften mithilfe von $.=value senden. Beispielsweise legt $.cid=12345 die System-Korrelations-ID-Eigenschaft fest. Weitere Beispiele für Systemeigenschaftsbezeichner umfassen $.ct für Inhaltstyp, $.mid für die Nachrichten-ID und $.ce für die Inhaltscodierung. Für http Messaging - Anwendungseigenschaften werden mithilfe von iothub-app-=value gesendet, z. B. iothub-app-myprop=myvalue. Systemeigenschaften werden im Allgemeinen mit iothub- wie iothub-Korrelationsid präfixiert, aber es gibt Ausnahmen wie Inhaltstyp und Inhaltscodierung.

--proto --protocol

Gibt das Geräte-zu-Cloud-Nachrichtenprotokoll an.

Zulässige Werte: http, mqtt

Standardwert: mqtt

--receive-settle --rs

Gibt an, wie empfangene Cloud-to-Device-Nachrichten festgelegt werden. Nur mit HTTP unterstützt.

Zulässige Werte: abandon, complete, reject

Standardwert: complete

--resource-group -g

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

--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 device upload-file

Laden Sie eine lokale Datei als Gerät in einen vorab konfigurierten Blobspeichercontainer hoch.

az iot device upload-file --content-type
                          --device-id
                          --file-path
                          [--hub-name]
                          [--login]
                          [--resource-group]

Erforderliche Parameter

--content-type --ct

MIME-Dateityp.

--device-id -d

Zielgerät.

--file-path --fp

Pfad zur Datei zum Hochladen.

Optionale Parameter

--hub-name -n

IoT Hub Name. Erforderlich, wenn die Anmeldung nicht bereitgestellt wird.

--login -l

--resource-group -g

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

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

Befehle

az iot device send-d2c-message

Beispiele

Erforderliche Parameter

Optionale Parameter

az iot device simulate

Beispiele

Erforderliche Parameter

Optionale Parameter

az iot device upload-file

Erforderliche Parameter

Optionale Parameter

Feedback