az iot device c2d-message

Referenz

Hinweis

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

Cloud-to-device Messaging-Befehle.

Befehle

az iot device c2d-message abandon	Verlassen Sie eine Cloud-zu-Gerät-Nachricht.
az iot device c2d-message complete	Schließen Sie eine Cloud-zu-Gerät-Nachricht ab.
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 receive	Empfangen einer Cloud-zu-Gerät-Nachricht.
az iot device c2d-message reject	Ablehnen oder Totlettieren einer Cloud-zu-Gerät-Nachricht.
az iot device c2d-message send	Senden einer Cloud-zu-Gerät-Nachricht.

az iot device c2d-message abandon

Verlassen Sie eine Cloud-zu-Gerät-Nachricht.

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

Erforderliche Parameter

--device-id -d

Zielgerät.

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. Erforderlich, wenn die Anmeldung nicht angegeben wird.

--login -l

Dieser Befehl unterstützt eine Entitätsverbindungszeichenfolge mit Rechten zum Ausführen einer Aktion. Verwenden Sie die Verwendung, um die Sitzungsanmeldung über "az login" zu vermeiden. Wenn sowohl eine Entitätsverbindungszeichenfolge 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.

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

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. Erforderlich, wenn die Anmeldung 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

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

Optionale Parameter

--hub-name -n

IoT Hub Name. Erforderlich, wenn die Anmeldung 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

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

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

Hinweis: Es wird nur ein Meldungsargument [--complete, --reject, --abandon] 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 als "abgeschlossen" nach dem Empfang einer Nachricht

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

Empfangen einer Nachricht und ablehnen, nachdem sie empfangen wurde

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

Erforderliche Parameter

--device-id -d

Zielgerät.

Optionale Parameter

--abandon

Verlassen Sie die Cloud-zu-Gerät-Nachricht nach erhalt.

Zulässige Werte: false, true

--complete

Schließen Sie die Cloud-zu-Gerät-Nachricht nach erhalt ab.

Zulässige Werte: false, true

--hub-name -n

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

--lock-timeout --lt

Gibt an, wie lange eine Nachricht für andere Empfangende Anrufe unsichtbar ist.

Standardwert: 60

--login -l

--reject

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

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

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

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. Erforderlich, wenn die Anmeldung 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

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

az iot device c2d-message send --device-id
                               [--ack {full, negative, positive}]
                               [--auth-type {key, login}]
                               [--ce]
                               [--cid]
                               [--content-type]
                               [--da]
                               [--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 von Cloud-zu-Gerät-Nachrichten mit benutzerdefinierten Daten und Eigenschaften.

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 Gerätebestätigung

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

Erforderliche Parameter

--device-id -d

Zielgerät.

Optionale Parameter

--ack

Fordern Sie die Übermittlung von Feedback per Nachricht bezüglich des endgültigen Zustands dieser Nachricht an. Die Beschreibung der ack-Werte lautet wie folgt. Positiv: Wenn die c2d-Nachricht den Status "Abgeschlossen" erreicht, generiert IoT Hub eine Feedbacknachricht. Negativ: Wenn die c2d-Nachricht den Status "Tote Buchstaben" erreicht, generiert IoT Hub eine Feedbacknachricht. Voll: 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. 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 C2D-Nachrichtentext.

--da --data

Nachrichtentext.

Standardwert: Ping from Az CLI IoT Extension

--expiry --expiry-time-utc

Einheiten sind Millisekunden seit unix-Epoche. Wenn keine Zeit angegeben wird, wird die Standard-IoT Hub C2D-Nachricht TTL verwendet.

--hub-name -n

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

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

--message-id --mid

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

--properties --props -p

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

--repair -r

Installieren Sie Uamqp-Abhängigkeiten neu, die mit der Erweiterungsversion kompatibel sind. Standardwert: false.

Zulässige Werte: false, true

--resource-group -g

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

--uid --user-id

Die C2D-Nachricht, die Benutzer-ID-Eigenschaft.

--wait -w

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

Zulässige Werte: false, true

--yes -y

Überspringen Sie Benutzeraufforderungen. Gibt die Akzeptanz der Abhängigkeitsinstallation (falls erforderlich) an. Wird in erster Linie für Automatisierungsszenarien verwendet. Standardwert: false.

Zulässige Werte: false, true

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.