az iot hub message-route

  • Förhandsgranskning
  • Referens

Kommentar

Den här referensen är en del av azure-iot-tillägget för Azure CLI (version 2.46.0 eller senare). Tillägget installeras automatiskt första gången du kör kommandot az iot hub message-route . Läs mer om tillägg.

Den här kommandogruppen är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Hantera vägar för en IoT-hubb.

Kommandon

Name Description Typ Status
az iot hub message-route create

Lägg till en väg för en IoT Hub.

 Anknytning Förhandsversion
az iot hub message-route delete

Ta bort alla vägar eller en nämnda väg i en IoT Hub.

 Anknytning Förhandsversion
az iot hub message-route fallback

Hantera återställningsvägen för en IoT-hubb.

 Anknytning Förhandsversion
az iot hub message-route fallback set

Aktivera eller inaktivera återställningsvägen i en IoT Hub.

 Anknytning Förhandsversion
az iot hub message-route fallback show

Visa återställningsvägen för en IoT Hub.

 Anknytning Förhandsversion
az iot hub message-route list

Hämta alla vägar i en IoT Hub.

 Anknytning Förhandsversion
az iot hub message-route show

Hämta information om vägen i en IoT Hub.

 Anknytning Förhandsversion
az iot hub message-route test

Testa alla vägar eller en nämnda väg i en IoT Hub.

 Anknytning Förhandsversion
az iot hub message-route update

Uppdatera en väg för en IoT Hub.

 Anknytning Förhandsversion

az iot hub message-route create

Förhandsgranskning

Kommandogruppen "iot hub message-route" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Lägg till en väg för en IoT Hub.

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]

Exempel

Skapa en väg för en IoT Hub med den angivna slutpunkten och källtypen "DeviceMessages".

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

Skapa en väg för en IoT Hub med den inbyggda slutpunkten och källtypen "DeviceMessages".

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

Skapa en inaktiverad väg för en IoT Hub med den angivna slutpunkten, källtypen "DigitalTwinChangeEvents" och anpassat villkor.

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

Obligatoriska parametrar

--en --endpoint --endpoint-name

Namn på routningsslutpunkten. För den inbyggda slutpunkten använder du slutpunktsnamnet "events".

--hub-name -n

IoT Hub-namn.

--rn --route --route-name

Namnet på vägen.

--source-type --type -t

Källan till vägen.

Godkända värden: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

Valfria parametrar

--condition -c

Villkor som utvärderas för att tillämpa routningsregeln.

Standardvärde: true
--enabled -e

Ett booleskt värde som anger om vägen ska aktiveras till IoT Hub.

Godkända värden: false, true
Standardvärde: True
--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot hub message-route delete

Förhandsgranskning

Kommandogruppen "iot hub message-route" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Ta bort alla vägar eller en nämnda väg i en IoT Hub.

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

Exempel

Ta bort en väg från en IoT Hub.

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

Ta bort alla vägar av källtypen "DeviceMessages" från en IoT Hub.

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

Ta bort alla vägar från en IoT Hub.

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

Obligatoriska parametrar

--hub-name -n

IoT Hub-namn.

Valfria parametrar

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--rn --route --route-name

Namnet på vägen.

--source-type --type -t

Källan till vägen.

Godkända värden: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--yes -y

Hoppa över användarprompter. Anger godkännande av åtgärd. Används främst för automatiseringsscenarier. Standard: falskt.

Godkända värden: false, true
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot hub message-route list

Förhandsgranskning

Kommandogruppen "iot hub message-route" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Hämta alla vägar i en IoT Hub.

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

Exempel

Hämta alla vägar från en IoT Hub.

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

Hämta alla vägar av källtypen "DeviceMessages" från en IoT Hub.

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

Obligatoriska parametrar

--hub-name -n

IoT Hub-namn.

Valfria parametrar

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--source-type --type -t

Källan till vägen.

Godkända värden: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot hub message-route show

Förhandsgranskning

Kommandogruppen "iot hub message-route" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Hämta information om vägen i en IoT Hub.

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

Exempel

Hämta routningsinformation från en IoT Hub.

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

Obligatoriska parametrar

--hub-name -n

IoT Hub-namn.

--rn --route --route-name

Namnet på vägen.

Valfria parametrar

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot hub message-route test

Förhandsgranskning

Kommandogruppen "iot hub message-route" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Testa alla vägar eller en nämnda väg i en IoT Hub.

Du kan ange ett exempelmeddelande för att testa dina vägar.

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

Exempel

Testa en väg från en IoT Hub.

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

Testa alla vägar av källtypen "DeviceMessages" från en IoT Hub.

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

Testa alla vägar från en IoT Hub med ett anpassat meddelande, inklusive brödtext, appegenskaper och systemegenskaper.

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

Obligatoriska parametrar

--hub-name -n

IoT Hub-namn.

Valfria parametrar

--ap --app-properties

Appegenskaper för routningsmeddelandet.

--body -b

Brödtexten i vägmeddelandet.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--rn --route --route-name

Namnet på vägen.

--source-type --type -t

Källan till vägen.

Godkända värden: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--sp --system-properties

Systemegenskaper för routningsmeddelandet.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot hub message-route update

Förhandsgranskning

Kommandogruppen "iot hub message-route" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Uppdatera en väg för en IoT Hub.

Du kan ändra källan, slutpunkten, villkoret eller det aktiverade tillståndet på vägen.

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

Exempel

Uppdatera en väg till en viss slutpunkt och källtyp "DeviceMessages".

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

Inaktivera en väg.

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

Ändra en vägs villkor.

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

Obligatoriska parametrar

--hub-name -n

IoT Hub-namn.

--rn --route --route-name

Namnet på vägen.

Valfria parametrar

--condition -c

Villkor som utvärderas för att tillämpa routningsregeln.

--en --endpoint --endpoint-name

Namn på routningsslutpunkten. För den inbyggda slutpunkten använder du slutpunktsnamnet "events".

--enabled -e

Ett booleskt värde som anger om vägen ska aktiveras till IoT Hub.

Godkända värden: false, true
--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--source-type --type -t

Källan till vägen.

Godkända värden: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.