az iot device c2d-message

  • Referenz

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-Gerät c2d-Message-Befehl zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen

Cloud-to-Device-Messagingbefehle.

Befehle

Name Beschreibung Typ Status
az iot device c2d-message abandon

Verlassen Sie eine Cloud-to-Device-Nachricht.

 Durchwahl Allgemein verfügbar
az iot device c2d-message complete

Schließen Sie eine Cloud-zu-Gerät-Nachricht ab.

 Durchwahl Allgemein verfügbar
az iot device c2d-message purge

Löschen der Nachrichtenwarteschlange für Cloud-zu-Gerät für ein Zielgerät.

 Durchwahl Allgemein verfügbar
az iot device c2d-message receive

Empfangen einer Cloud-zu-Gerät-Nachricht.

 Durchwahl Allgemein verfügbar
az iot device c2d-message reject

Ablehnen oder Totlettieren einer Cloud-zu-Gerät-Nachricht.

 Durchwahl Allgemein verfügbar
az iot device c2d-message send

Senden sie eine Cloud-zu-Gerät-Nachricht.

 Durchwahl Allgemein verfügbar

az iot device c2d-message abandon

Verlassen Sie eine Cloud-to-Device-Nachricht.

az iot device c2d-message abandon --device-id
                                  [--etag]
                                  [--hub-name]
                                  [--login]
                                  [--resource-group]

Erforderliche Parameter

--device-id -d

Zielgeräte-ID.

Optionale Parameter

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

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.

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

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 device c2d-message complete

Schließen Sie eine Cloud-zu-Gerät-Nachricht ab.

az iot device c2d-message complete --device-id
                                   [--etag]
                                   [--hub-name]
                                   [--login]
                                   [--resource-group]

Erforderliche Parameter

--device-id -d

Zielgeräte-ID.

Optionale Parameter

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

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.

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

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 device c2d-message purge

Löschen der Nachrichtenwarteschlange für Cloud-zu-Gerät für ein Zielgerät.

az iot device c2d-message purge --device-id
                                [--hub-name]
                                [--login]
                                [--resource-group]

Erforderliche Parameter

--device-id -d

Zielgeräte-ID.

Optionale Parameter

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

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

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 device c2d-message receive

Empfangen einer Cloud-zu-Gerät-Nachricht.

Der Empfangene Nachrichtentext wird nur decodiert, wenn die Inhaltscodierung auf "utf-8", "utf-16" oder "utf-32" festgelegt ist. Die Nachrichtennutzlast wird als {{nicht decodierbare Nutzlast}} angezeigt, wenn die Inhaltscodierung nicht auf eine der obigen Dateien festgelegt ist oder die Codierung auch dann nicht decodiert werden kann, wenn die Inhaltscodierung auf eine der oben genannten Codierungen festgelegt ist.

Hinweis: Nur ein Nachrichten-Ack-Argument [--complete, --reject, ---abandon] wird akzeptiert.

az iot device c2d-message receive --device-id
                                  [--abandon {false, true}]
                                  [--complete {false, true}]
                                  [--hub-name]
                                  [--lock-timeout]
                                  [--login]
                                  [--reject {false, true}]
                                  [--resource-group]

Beispiele

Grundlegende Verwendung

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group}

Empfangen einer Nachricht und Festlegen eines Sperrtimeouts von 30 Sekunden für diese Nachricht

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --lt {30}

Empfangen einer Nachricht und "Vollständig" nach Erhalt einer Nachricht

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --complete

Empfangen einer Nachricht und Ablehnen nach dem Empfang

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --reject

Erforderliche Parameter

--device-id -d

Zielgeräte-ID.

Optionale Parameter

--abandon

Verlassen Sie die Nachricht nach dem Empfang in der Cloud-zu-Gerät.

Zulässige Werte: false, true
Standardwert: False
--complete

Schließen Sie die Nachricht nach dem Empfang der Cloud-zu-Gerät ab.

Zulässige Werte: false, true
Standardwert: False
--hub-name -n

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

--lock-timeout --lt

Gibt an, wie lange eine Nachricht für andere Empfangen von Anrufen unsichtbar ist.

Standardwert: 60
--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.

--reject

Ablehnen der Cloud-zu-Gerät-Nachricht nach erhalt.

Zulässige Werte: false, true
Standardwert: False
--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.

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 device c2d-message reject

Ablehnen oder Totlettieren einer Cloud-zu-Gerät-Nachricht.

az iot device c2d-message reject --device-id
                                 [--etag]
                                 [--hub-name]
                                 [--login]
                                 [--resource-group]

Erforderliche Parameter

--device-id -d

Zielgeräte-ID.

Optionale Parameter

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

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.

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

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 device c2d-message send

Senden sie eine Cloud-zu-Gerät-Nachricht.

Dieser Befehl basiert auf und kann abhängiges Cython-Paket (uamqp) bei der ersten Ausführung installieren. https://github.com/Azure/azure-uamqp-python

Hinweis: Die Inhaltscodierung ist standardmäßig auf utf-8 festgelegt. Der Befehl sendet den Nachrichtentext mit Codierungsaktion, wenn die Inhaltscodierungseigenschaft entweder utf-8, utf-16 oder utf-32 ist. Wenn der Wert der Inhaltscodierung nicht einer dieser Werte ist, wird die Eigenschaft weiterhin ohne Codierungsaktion gesendet.

Beim Senden eines binären Nachrichtentexts muss der Inhalt aus einer Datei (via --data-file-path) bereitgestellt werden, und der Inhaltstyp muss auf " application/octet-stream.

az iot device c2d-message send --device-id
                               [--ack {full, negative, positive}]
                               [--auth-type {key, login}]
                               [--ce]
                               [--cid]
                               [--content-type]
                               [--da]
                               [--data-file-path]
                               [--expiry]
                               [--hub-name]
                               [--login]
                               [--message-id]
                               [--properties]
                               [--repair {false, true}]
                               [--resource-group]
                               [--uid]
                               [--wait {false, true}]
                               [--yes {false, true}]

Beispiele

Grundlegende Verwendung mit Standardnachrichtentext

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

Senden sie eine Nachricht mit benutzerdefinierten Daten und Eigenschaften in der Cloud zu Gerät.

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

Senden einer C2D-Nachricht und Warten auf die Gerätebestätigung

az iot device c2d-message send -d {device_id} -n {iothub_name} --ack full --wait

Senden Sie eine C2D-Nachricht im Binärformat aus einer Datei.

az iot device c2d-message send -d {device_id} -n {iothub_name} --data-file-path {file_path} --content-type 'application/octet-stream'

Senden Sie eine C2D-Nachricht im JSON-Format aus einer Datei.

az iot device c2d-message send -d {device_id} -n {iothub_name} --data-file-path {file_path} --content-type 'application/json'

Erforderliche Parameter

--device-id -d

Zielgeräte-ID.

Optionale Parameter

--ack

Fordern Sie die Übermittlung von Feedback pro Nachricht bezüglich des endgültigen Status dieser Nachricht an. Die Beschreibung von Ack-Werten lautet wie folgt. Positiv: Wenn die c2d-Nachricht den Status "Abgeschlossen" erreicht, generiert IoT Hub eine Feedbacknachricht. Negativ: Wenn die c2d-Nachricht den Status "Inaktiv" erreicht, generiert IoT Hub eine Feedbacknachricht. Vollständig: IoT Hub generiert in beiden Fällen eine Feedbacknachricht. Standardmäßig wird keine Ack angefordert.

Zulässige Werte: full, negative, positive
--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
--ce --content-encoding

Die Codierung für den C2D-Nachrichtentext.

Standardwert: utf-8
--cid --correlation-id

Die Korrelations-ID, die der C2D-Nachricht zugeordnet ist.

--content-type --ct

Der Inhaltstyp für den Textkörper der C2D-Nachricht.

--da --data

Nachrichtentext. Geben Sie Text oder unformatierte JSON an.

Standardwert: Ping from Az CLI IoT Extension
--data-file-path --dfp
Vorschau

Geben Sie Pfad zur Datei für die Nachrichtentextnutzlast an. Bitte beachten Sie, dass die Nutzlast im Binärformat gesendet werden muss, den Inhaltstyp auf "Application/octet-stream" festlegen.

--expiry --expiry-time-utc

Einheiten sind Millisekunden seit unix-Epoche. Wenn keine Uhrzeit angegeben ist, wird die Standardmäßige IoT Hub C2D-Meldung TTL verwendet.

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

--message-id --mid

Die C2D-Nachrichten-ID. Wenn keine Nachrichten-ID angegeben wird, wird eine UUID generiert.

--properties --props -p

Nachrichteneigenschaftenbehälter in Schlüsselwertpaaren mit dem folgenden Format: a=b; c=d.

--repair -r

Installieren Sie uamqp-Abhängigkeit neu, die mit der Erweiterungsversion kompatibel ist. Standardwert: false.

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

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

--uid --user-id

Die C2D-Nachricht, Benutzer-ID-Eigenschaft.

--wait -w

Wenn der c2d-Sendevorgang festgelegt wird, wird blockiert, bis Gerätefeedback empfangen wurde.

Zulässige Werte: false, true
Standardwert: False
--yes -y

Benutzeraufforderungen überspringen. Gibt die Annahme der Aktion an. Wird hauptsächlich für Automatisierungsszenarien verwendet. Standardwert: false.

Zulässige Werte: false, true
Standardwert: False
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.