az iot hub message-route

Note

Tento odkaz je součástí rozšíření azure-iot pro Azure CLI (verze 2.67.0 nebo vyšší). Rozšíření se automaticky nainstaluje při prvním spuštění příkazu az iot hub message-route. Přečtěte si další informace o rozšířeních.

Tato skupina příkazů je ve verzi Preview a ve vývoji. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Správa tras centra IoT

Příkazy

Name	Description	Typ	Stav
az iot hub message-route create	Přidejte trasu pro IoT Hub.	Extension	Preview
az iot hub message-route delete	Odstraňte všechny trasy nebo uvedenou trasu ve službě IoT Hub.	Extension	Preview
az iot hub message-route fallback	Spravujte náhradní trasu centra IoT.	Extension	Preview
az iot hub message-route fallback set	Povolte nebo zakažte náhradní trasu ve službě IoT Hub.	Extension	Preview
az iot hub message-route fallback show	Zobrazí náhradní trasu ioT Hubu.	Extension	Preview
az iot hub message-route list	Získejte všechny trasy ve službě IoT Hub.	Extension	Preview
az iot hub message-route show	Získejte informace o trase ve službě IoT Hub.	Extension	Preview
az iot hub message-route test	Otestujte všechny trasy nebo uvedenou trasu ve službě IoT Hub.	Extension	Preview
az iot hub message-route update	Aktualizujte trasu pro IoT Hub.	Extension	Preview

az iot hub message-route create

Preview

Skupina příkazů iot Hub message-route je ve verzi Preview a ve vývoji. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Přidejte trasu pro IoT Hub.

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]

Příklady

Vytvořte trasu pro IoT Hub s daným koncovým bodem a typem zdroje DeviceMessages.

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

Vytvořte trasu pro IoT Hub s integrovaným koncovým bodem a typem zdroje DeviceMessages.

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

Vytvořte zakázanou trasu pro IoT Hub s daným koncovým bodem, typ zdroje "DigitalTwinChangeEvents" a vlastní podmínku.

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

Povinné parametry

--en --endpoint --endpoint-name

Název koncového bodu směrování Pro předdefinovaný koncový bod použijte název koncového bodu "events".

--hub-name -n

Název ioT Hubu

--rn --route --route-name

Název trasy.

--source-type --type -t

Zdroj trasy.

Vlastnost	Hodnota
Přípustné hodnoty:	deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--condition -c

Podmínka, která se vyhodnotí jako použití pravidla směrování.

Vlastnost	Hodnota
Default value:	true

--enabled -e

Logická hodnota označující, jestli se má povolit směrování do IoT Hubu.

Vlastnost	Hodnota
Default value:	True
Přípustné hodnoty:	false, true

--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Globální parametry

--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost	Hodnota
Default value:	False

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost	Hodnota
Default value:	False

--output -o

Výstupní formát

Vlastnost	Hodnota
Default value:	json
Přípustné hodnoty:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost	Hodnota
Default value:	False

az iot hub message-route delete

Preview

Skupina příkazů iot Hub message-route je ve verzi Preview a ve vývoji. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Odstraňte všechny trasy nebo uvedenou trasu ve službě 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}]

Příklady

Odstraňte trasu ze služby IoT Hub.

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

Odstraňte všechny trasy zdrojového typu DeviceMessages ze služby IoT Hub.

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

Odstraňte všechny trasy ze služby IoT Hub.

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

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--hub-name -n

Název ioT Hubu

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--ids

Jedno nebo více ID prostředků (oddělené mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat buď argumenty --ids, nebo jiné argumenty 'ID prostředku'.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--rn --route --route-name

Název trasy.

--source-type --type -t

Zdroj trasy.

Vlastnost	Hodnota
Přípustné hodnoty:	deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--yes -y

Přeskočte výzvy uživatele. Označuje přijetí akce. Používá se především pro scénáře automatizace. Výchozí hodnota: false.

Vlastnost	Hodnota
Přípustné hodnoty:	false, true

Globální parametry

--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost	Hodnota
Default value:	False

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost	Hodnota
Default value:	False

--output -o

Výstupní formát

Vlastnost	Hodnota
Default value:	json
Přípustné hodnoty:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost	Hodnota
Default value:	False

az iot hub message-route list

Preview

Skupina příkazů iot Hub message-route je ve verzi Preview a ve vývoji. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Získejte všechny trasy ve službě IoT Hub.

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

Příklady

Získejte všechny trasy ze služby IoT Hub.

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

Získejte všechny trasy zdrojového typu DeviceMessages ze služby IoT Hub.

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

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--hub-name -n

Název ioT Hubu

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--ids

Jedno nebo více ID prostředků (oddělené mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat buď argumenty --ids, nebo jiné argumenty 'ID prostředku'.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--source-type --type -t

Zdroj trasy.

Vlastnost	Hodnota
Přípustné hodnoty:	deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

Globální parametry

--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost	Hodnota
Default value:	False

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost	Hodnota
Default value:	False

--output -o

Výstupní formát

Vlastnost	Hodnota
Default value:	json
Přípustné hodnoty:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost	Hodnota
Default value:	False

az iot hub message-route show

Preview

Skupina příkazů iot Hub message-route je ve verzi Preview a ve vývoji. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Získejte informace o trase ve službě IoT Hub.

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

Příklady

Získání informací o trasách ze služby IoT Hub

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

Povinné parametry

--rn --route --route-name

Název trasy.

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--hub-name -n

Název ioT Hubu

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--ids

Jedno nebo více ID prostředků (oddělené mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat buď argumenty --ids, nebo jiné argumenty 'ID prostředku'.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

Globální parametry

--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost	Hodnota
Default value:	False

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost	Hodnota
Default value:	False

--output -o

Výstupní formát

Vlastnost	Hodnota
Default value:	json
Přípustné hodnoty:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost	Hodnota
Default value:	False

az iot hub message-route test

Preview

Skupina příkazů iot Hub message-route je ve verzi Preview a ve vývoji. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Otestujte všechny trasy nebo uvedenou trasu ve službě IoT Hub.

Můžete zadat ukázkovou zprávu pro otestování tras.

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]

Příklady

Otestujte trasu ze služby IoT Hub.

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

Otestujte všechny trasy zdrojového typu DeviceMessages ze služby IoT Hub.

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

Otestujte veškerou trasu ze služby IoT Hub s vlastní zprávou, včetně textu, vlastností aplikace a systémových vlastností.

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

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--ap --app-properties

Vlastnosti aplikace zprávy trasy

--body -b

Text zprávy trasy

--hub-name -n

Název ioT Hubu

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--ids

Jedno nebo více ID prostředků (oddělené mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat buď argumenty --ids, nebo jiné argumenty 'ID prostředku'.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--rn --route --route-name

Název trasy.

--source-type --type -t

Zdroj trasy.

Vlastnost	Hodnota
Přípustné hodnoty:	deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

--sp --system-properties

Systémové vlastnosti zprávy trasy.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

Globální parametry

--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost	Hodnota
Default value:	False

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost	Hodnota
Default value:	False

--output -o

Výstupní formát

Vlastnost	Hodnota
Default value:	json
Přípustné hodnoty:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost	Hodnota
Default value:	False

az iot hub message-route update

Preview

Skupina příkazů iot Hub message-route je ve verzi Preview a ve vývoji. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Aktualizujte trasu pro IoT Hub.

Na trase můžete změnit zdroj, koncový bod, podmínku nebo povolený stav.

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]

Příklady

Aktualizujte trasu na daný koncový bod a typ zdroje DeviceMessages.

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

Zakažte trasu.

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

Změňte podmínku trasy.

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

Povinné parametry

--rn --route --route-name

Název trasy.

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--condition -c

Podmínka, která se vyhodnotí jako použití pravidla směrování.

--en --endpoint --endpoint-name

Název koncového bodu směrování Pro předdefinovaný koncový bod použijte název koncového bodu "events".

--enabled -e

Logická hodnota označující, jestli se má povolit směrování do IoT Hubu.

Vlastnost	Hodnota
Přípustné hodnoty:	false, true

--hub-name -n

Název ioT Hubu

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--ids

Jedno nebo více ID prostředků (oddělené mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat buď argumenty --ids, nebo jiné argumenty 'ID prostředku'.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

--source-type --type -t

Zdroj trasy.

Vlastnost	Hodnota
Přípustné hodnoty:	deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Vlastnost	Hodnota
Skupina parametrů:	Resource Id Arguments

Globální parametry

--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost	Hodnota
Default value:	False

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost	Hodnota
Default value:	False

--output -o

Výstupní formát

Vlastnost	Hodnota
Default value:	json
Přípustné hodnoty:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost	Hodnota
Default value:	False