Share via

az iot hub message-route

  • Anteprima
  • Riferimento

Nota

Questo riferimento fa parte dell'estensione azure-iot per l'interfaccia della riga di comando di Azure (versione 2.37.0 o successiva). L'estensione installerà automaticamente la prima volta che si esegue un comando az iot hub message-route . Altre informazioni sulle estensioni.

Questo gruppo di comandi è in anteprima e in fase di sviluppo. Livelli di riferimento e supporto: https://aka.ms/CLI_refstatus

Gestire le route di un hub IoT.

Comandi

Nome Descrizione Tipo Stato
az iot hub message-route create

Aggiungere una route per un hub IoT.

 Estensione Anteprima
az iot hub message-route delete

Eliminare tutte le route o una route indicata in un hub IoT.

 Estensione Anteprima
az iot hub message-route fallback

Gestire la route di fallback di un hub IoT.

 Estensione Anteprima
az iot hub message-route fallback set

Abilitare o disabilitare la route di fallback in un hub IoT.

 Estensione Anteprima
az iot hub message-route fallback show

Visualizzare la route di fallback di un hub IoT.

 Estensione Anteprima
az iot hub message-route list

Ottenere tutte le route in un hub IoT.

 Estensione Anteprima
az iot hub message-route show

Ottenere informazioni sulla route in un hub IoT.

 Estensione Anteprima
az iot hub message-route test

Testare tutte le route o una route menzionata in un hub IoT.

 Estensione Anteprima
az iot hub message-route update

Aggiornare una route per un hub IoT.

 Estensione Anteprima

az iot hub message-route create

Anteprima

Il gruppo di comandi 'iot hub message-route' è in anteprima e in fase di sviluppo. Livelli di riferimento e supporto: https://aka.ms/CLI_refstatus

Aggiungere una route per un hub IoT.

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

Esempio

Creare una route per un hub IoT con l'endpoint specificato e il tipo di origine "DeviceMessages".

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

Creare una route per un hub IoT con l'endpoint predefinito e il tipo di origine "DeviceMessages".

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

Creare una route disabilitata per un hub IoT con l'endpoint specificato, il tipo di origine "DigitalTwinChangeEvents" e la condizione personalizzata.

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

Parametri necessari

--en --endpoint --endpoint-name

Nome dell'endpoint di routing. Per l'endpoint predefinito, usare il nome dell'endpoint 'events'.

--hub-name -n

hub IoT nome.

--rn --route --route-name

Nome della route.

--source-type --type -t

Origine della route.

valori accettati: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

Parametri facoltativi

--condition -c

Condizione valutata per applicare la regola di routing.

valore predefinito: true
--enabled -e

Valore booleano che indica se abilitare la route al hub IoT.

valori accettati: false, true
valore predefinito: True
--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az iot hub message-route delete

Anteprima

Il gruppo di comandi 'iot hub message-route' è in anteprima e in fase di sviluppo. Livelli di riferimento e supporto: https://aka.ms/CLI_refstatus

Eliminare tutte le route o una route indicata in un hub IoT.

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

Esempio

Eliminare una route da un hub IoT.

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

Eliminare tutte le route del tipo di origine "DeviceMessages" da un hub IoT.

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

Eliminare tutte le route da un hub IoT.

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

Parametri necessari

--hub-name -n

hub IoT nome.

Parametri facoltativi

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

--rn --route --route-name

Nome della route.

--source-type --type -t

Origine della route.

valori accettati: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--yes -y

Ignorare le richieste dell'utente. Indica l'accettazione dell'azione. Usato principalmente per gli scenari di automazione. Valore predefinito: false.

valori accettati: false, true
Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az iot hub message-route list

Anteprima

Il gruppo di comandi 'iot hub message-route' è in anteprima e in fase di sviluppo. Livelli di riferimento e supporto: https://aka.ms/CLI_refstatus

Ottenere tutte le route in un hub IoT.

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

Esempio

Ottenere tutte le route da un hub IoT.

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

Ottenere tutte le route del tipo di origine "DeviceMessages" da un hub IoT.

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

Parametri necessari

--hub-name -n

hub IoT nome.

Parametri facoltativi

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

--source-type --type -t

Origine della route.

valori accettati: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az iot hub message-route show

Anteprima

Il gruppo di comandi 'iot hub message-route' è in anteprima e in fase di sviluppo. Livelli di riferimento e supporto: https://aka.ms/CLI_refstatus

Ottenere informazioni sulla route in un hub IoT.

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

Esempio

Ottenere informazioni sulla route da un hub IoT.

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

Parametri necessari

--hub-name -n

hub IoT nome.

--rn --route --route-name

Nome della route.

Parametri facoltativi

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az iot hub message-route test

Anteprima

Il gruppo di comandi 'iot hub message-route' è in anteprima e in fase di sviluppo. Livelli di riferimento e supporto: https://aka.ms/CLI_refstatus

Testare tutte le route o una route menzionata in un hub IoT.

È possibile fornire un messaggio di esempio per testare le route.

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

Esempio

Testare una route da un hub IoT.

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

Testare tutte le route del tipo di origine "DeviceMessages" da un hub IoT.

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

Testare tutte le route da un hub IoT con un messaggio personalizzato, inclusi corpo, proprietà dell'app e proprietà di sistema.

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

Parametri necessari

--hub-name -n

hub IoT nome.

Parametri facoltativi

--ap --app-properties

Proprietà dell'app del messaggio di route.

--body -b

Corpo del messaggio di route.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

--rn --route --route-name

Nome della route.

--source-type --type -t

Origine della route.

valori accettati: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--sp --system-properties

Proprietà di sistema del messaggio di route.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az iot hub message-route update

Anteprima

Il gruppo di comandi 'iot hub message-route' è in anteprima e in fase di sviluppo. Livelli di riferimento e supporto: https://aka.ms/CLI_refstatus

Aggiornare una route per un hub IoT.

È possibile modificare lo stato di origine, endpoint, condizione o abilitato nella route.

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

Esempio

Aggiornare una route a un determinato endpoint e al tipo di origine "DeviceMessages".

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

Disabilitare una route.

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

Modificare la condizione di una route.

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

Parametri necessari

--hub-name -n

hub IoT nome.

--rn --route --route-name

Nome della route.

Parametri facoltativi

--condition -c

Condizione valutata per applicare la regola di routing.

--en --endpoint --endpoint-name

Nome dell'endpoint di routing. Per l'endpoint predefinito, usare il nome dell'endpoint 'events'.

--enabled -e

Valore booleano che indica se abilitare la route al hub IoT.

valori accettati: false, true
--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

--source-type --type -t

Origine della route.

valori accettati: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.