az iot hub message-route

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 einen az iot hub message-route Befehl ausführen. Erfahren Sie mehr über Erweiterungen.

Diese Befehlsgruppe befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Verwalten von Routen einer IoT Hub-Instanz.

Befehle

Name	Beschreibung	Typ	Status
az iot hub message-route create	Fügen Sie eine Route für einen IoT-Hub hinzu.	Extension	Preview
az iot hub message-route delete	Löschen Sie alle Routen oder eine erwähnte Route in einem IoT Hub.	Extension	Preview
az iot hub message-route fallback	Verwalten Sie die Fallbackroute eines IoT-Hubs.	Extension	Preview
az iot hub message-route fallback set	Aktivieren oder deaktivieren Sie die Fallbackroute in einem IoT Hub.	Extension	Preview
az iot hub message-route fallback show	Zeigen Sie die Fallbackroute eines IoT Hub an.	Extension	Preview
az iot hub message-route list	Rufen Sie alle Routen in einem IoT Hub ab.	Extension	Preview
az iot hub message-route show	Rufen Sie Informationen zur Route in einem IoT Hub ab.	Extension	Preview
az iot hub message-route test	Testen Sie alle Routen oder eine erwähnte Route in einem IoT Hub.	Extension	Preview
az iot hub message-route update	Aktualisieren einer Route für einen IoT-Hub.	Extension	Preview

az iot hub message-route create

Vorschau

Die Befehlsgruppe "iot hub message-route" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Fügen Sie eine Route für einen IoT-Hub hinzu.

az iot hub message-route create --en --endpoint --endpoint-name
                                --hub-name
                                --rn --route --route-name
                                --source-type --type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}
                                [--condition]
                                [--enabled {false, true}]
                                [--resource-group]

Beispiele

Erstellen Sie eine Route für einen IoT-Hub mit dem angegebenen Endpunkt und dem Quelltyp "DeviceMessages".

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DeviceMessages

Erstellen Sie eine Route für einen IoT-Hub mit dem integrierten Endpunkt und dem Quelltyp "DeviceMessages".

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name events --source DeviceMessages

Erstellen Sie eine deaktivierte Route für einen IoT Hub mit dem angegebenen Endpunkt, dem Quelltyp "DigitalTwinChangeEvents" und einer benutzerdefinierten Bedingung.

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DigitalTwinChangeEvents --condition {condition} --enabled false

Erforderliche Parameter

--en --endpoint --endpoint-name

Name des Routingendpunkts. Verwenden Sie für den integrierten Endpunkt den Endpunktnamen "Events".

--hub-name -n

IoT Hub-Name.

--rn --route --route-name

Der Name der Route.

--source-type --type -t

Quelle der Route.

Eigenschaft	Wert
Zulässige Werte:	deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

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.

--condition -c

Bedingung, die ausgewertet wird, um die Routingregel anzuwenden.

Eigenschaft	Wert
Standardwert:	true

--enabled -e

Ein boolescher Wert, der angibt, ob die Route zum IoT Hub aktiviert werden soll.

Eigenschaft	Wert
Standardwert:	True
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.

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 hub message-route delete

Vorschau

Die Befehlsgruppe "iot hub message-route" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Löschen Sie alle Routen oder eine erwähnte Route in einem IoT Hub.

az iot hub message-route delete [--hub-name]
                                [--ids]
                                [--resource-group]
                                [--rn --route --route-name]
                                [--source-type --type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                                [--subscription]
                                [--yes {false, true}]

Beispiele

Löschen einer Route von einem IoT Hub.

az iot hub message-route delete -n {iothub_name} --route-name {route_name}

Löschen Sie alle Routen vom Quelltyp "DeviceMessages" aus einem IoT-Hub.

az iot hub message-route delete -n {iothub_name} --source DeviceMessages

Löschen Sie alle Routen von einem IoT Hub.

az iot hub message-route delete -n {iothub_name}

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.

--hub-name -n

IoT Hub-Name.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--resource-group -g

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

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--rn --route --route-name

Der Name der Route.

--source-type --type -t

Quelle der Route.

Eigenschaft	Wert
Zulässige Werte:	deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--yes -y

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

Eigenschaft	Wert
Zulässige Werte:	false, true

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

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az iot hub message-route list

Vorschau

Die Befehlsgruppe "iot hub message-route" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Rufen Sie alle Routen in einem IoT Hub ab.

az iot hub message-route list [--hub-name]
                              [--ids]
                              [--resource-group]
                              [--source-type --type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                              [--subscription]

Beispiele

Rufen Sie alle Routen von einem IoT Hub ab.

az iot hub message-route list -n {iothub_name}

Rufen Sie alle Routen des Quelltyps "DeviceMessages" aus einem IoT Hub ab.

az iot hub message-route list -n {iothub_name} --source DeviceMessages

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.

--hub-name -n

IoT Hub-Name.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--resource-group -g

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

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--source-type --type -t

Quelle der Route.

Eigenschaft	Wert
Zulässige Werte:	deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

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

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az iot hub message-route show

Vorschau

Die Befehlsgruppe "iot hub message-route" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Rufen Sie Informationen zur Route in einem IoT Hub ab.

az iot hub message-route show --rn --route --route-name
                              [--hub-name]
                              [--ids]
                              [--resource-group]
                              [--subscription]

Beispiele

Abrufen von Routeninformationen von einem IoT-Hub.

az iot hub message-route show -n {iothub_name} --route-name {route_name}

Erforderliche Parameter

--rn --route --route-name

Der Name der Route.

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.

--hub-name -n

IoT Hub-Name.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--resource-group -g

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

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

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

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az iot hub message-route test

Vorschau

Die Befehlsgruppe "iot hub message-route" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Testen Sie alle Routen oder eine erwähnte Route in einem IoT Hub.

Sie können eine Beispielnachricht bereitstellen, um Ihre Routen zu testen.

az iot hub message-route test [--ap --app-properties]
                              [--body]
                              [--hub-name]
                              [--ids]
                              [--resource-group]
                              [--rn --route --route-name]
                              [--source-type --type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                              [--sp --system-properties]
                              [--subscription]

Beispiele

Testen Sie eine Route von einem IoT Hub.

az iot hub message-route test -n {iothub_name} --route-name {route_name}

Testen Sie alle Routen des Quelltyps "DeviceMessages" von einem IoT Hub.

az iot hub message-route test -n {iothub_name} --source DeviceMessages

Testen Sie alle Routen von einem IoT Hub mit einer benutzerdefinierten Nachricht, einschließlich Textkörper, App-Eigenschaften und Systemeigenschaften.

az iot hub message-route test -n {iothub_name} -b {body} --ap {app_properties} --sp {system_properties}

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.

--ap --app-properties

App-Eigenschaften der Route-Nachricht.

--body -b

Textkörper der Routennachricht.

--hub-name -n

IoT Hub-Name.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--resource-group -g

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

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--rn --route --route-name

Der Name der Route.

--source-type --type -t

Quelle der Route.

Eigenschaft	Wert
Zulässige Werte:	deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

--sp --system-properties

Systemeigenschaften der Route-Nachricht.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

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

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az iot hub message-route update

Vorschau

Die Befehlsgruppe "iot hub message-route" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Aktualisieren einer Route für einen IoT-Hub.

Sie können den Quell-, Endpunkt-, Bedingungs- oder aktivierten Zustand auf der Route ändern.

az iot hub message-route update --rn --route --route-name
                                [--condition]
                                [--en --endpoint --endpoint-name]
                                [--enabled {false, true}]
                                [--hub-name]
                                [--ids]
                                [--resource-group]
                                [--source-type --type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                                [--subscription]

Beispiele

Aktualisieren Sie eine Route zu einem bestimmten Endpunkt und dem Quelltyp "DeviceMessages".

az iot hub message-route update -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DeviceMessages

Deaktivieren Sie eine Route.

az iot hub message-route update -n {iothub_name} --route-name {route_name} --enabled false

Ändern Sie die Bedingung einer Route.

az iot hub message-route update -n {iothub_name} --route-name {route_name} --condition {condition}

Erforderliche Parameter

--rn --route --route-name

Der Name der Route.

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.

--condition -c

Bedingung, die ausgewertet wird, um die Routingregel anzuwenden.

--en --endpoint --endpoint-name

Name des Routingendpunkts. Verwenden Sie für den integrierten Endpunkt den Endpunktnamen "Events".

--enabled -e

Ein boolescher Wert, der angibt, ob die Route zum IoT Hub aktiviert werden soll.

Eigenschaft	Wert
Zulässige Werte:	false, true

--hub-name -n

IoT Hub-Name.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--resource-group -g

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

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--source-type --type -t

Quelle der Route.

Eigenschaft	Wert
Zulässige Werte:	deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

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

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False