az iot hub message-route

Notitie

Deze verwijzing maakt deel uit van de Azure-iot-extensie voor de Azure CLI (versie 2.46.0 of hoger). De extensie installeert automatisch de eerste keer dat u een az iot hub message-route-opdracht uitvoert. Meer informatie over extensies.

Deze opdrachtgroep is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Routes van een IoT-hub beheren.

Opdracht

Name	Description	Type	Status
az iot hub message-route create	Voeg een route toe voor een IoT Hub.	Toestel	Preview uitvoeren
az iot hub message-route delete	Verwijder alle routes of een vermelde route in een IoT Hub.	Toestel	Preview uitvoeren
az iot hub message-route fallback	Beheer de terugvalroute van een IoT-hub.	Toestel	Preview uitvoeren
az iot hub message-route fallback set	Schakel de terugvalroute in of uit in een IoT Hub.	Toestel	Preview uitvoeren
az iot hub message-route fallback show	De terugvalroute van een IoT Hub weergeven.	Toestel	Preview uitvoeren
az iot hub message-route list	Haal alle routes op in een IoT Hub.	Toestel	Preview uitvoeren
az iot hub message-route show	Informatie over de route in een IoT Hub ophalen.	Toestel	Preview uitvoeren
az iot hub message-route test	Test alle routes of een vermelde route in een IoT Hub.	Toestel	Preview uitvoeren
az iot hub message-route update	Werk een route voor een IoT Hub bij.	Toestel	Preview uitvoeren

az iot hub message-route create

Preview

Opdrachtgroep 'iot hub message-route' is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Voeg een route toe voor een 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]

Voorbeelden

Maak een route voor een IoT Hub met het opgegeven eindpunt en het brontype DeviceMessages.

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

Maak een route voor een IoT Hub met het ingebouwde eindpunt en het brontype DeviceMessages.

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

Maak een uitgeschakelde route voor een IoT Hub met het opgegeven eindpunt, het brontype DigitalTwinChangeEvents en de aangepaste voorwaarde.

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

Vereiste parameters

--en --endpoint --endpoint-name

Naam van het routeringseindpunt. Gebruik voor het ingebouwde eindpunt de eindpuntnaam 'gebeurtenissen'.

--hub-name -n

Naam van IoT Hub.

--rn --route --route-name

Naam van de route.

--source-type --type -t

Bron van de route.

Geaccepteerde waarden: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

Optionele parameters

--condition -c

Voorwaarde die wordt geëvalueerd om de routeringsregel toe te passen.

Default value: true

--enabled -e

Een Booleaanse waarde die aangeeft of route naar de IoT Hub moet worden ingeschakeld.

Geaccepteerde waarden: false, true

Default value: True

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Globale parameters

--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az iot hub message-route delete

Preview

Opdrachtgroep 'iot hub message-route' is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Verwijder alle routes of een vermelde route in een 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}]

Voorbeelden

Een route verwijderen uit een IoT Hub.

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

Verwijder alle routes van het brontype DeviceMessages uit een IoT Hub.

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

Verwijder alle routes uit een IoT Hub.

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

Vereiste parameters

--hub-name -n

Naam van IoT Hub.

Optionele parameters

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--rn --route --route-name

Naam van de route.

--source-type --type -t

Bron van de route.

Geaccepteerde waarden: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

--yes -y

Gebruikersprompts overslaan. Geeft de acceptatie van de actie aan. Wordt voornamelijk gebruikt voor automatiseringsscenario's. Standaard: onwaar.

Geaccepteerde waarden: false, true

Globale parameters

--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az iot hub message-route list

Preview

Opdrachtgroep 'iot hub message-route' is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Haal alle routes op in een IoT Hub.

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

Voorbeelden

Haal alle routes op uit een IoT Hub.

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

Haal alle routes van het brontype DeviceMessages op uit een IoT Hub.

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

Vereiste parameters

--hub-name -n

Naam van IoT Hub.

Optionele parameters

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--source-type --type -t

Bron van de route.

Geaccepteerde waarden: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

Globale parameters

--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az iot hub message-route show

Preview

Opdrachtgroep 'iot hub message-route' is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Informatie over de route in een IoT Hub ophalen.

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

Voorbeelden

Routegegevens ophalen uit een IoT Hub.

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

Vereiste parameters

--hub-name -n

Naam van IoT Hub.

--rn --route --route-name

Naam van de route.

Optionele parameters

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Globale parameters

--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az iot hub message-route test

Preview

Opdrachtgroep 'iot hub message-route' is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Test alle routes of een vermelde route in een IoT Hub.

U kunt een voorbeeldbericht opgeven om uw routes te testen.

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

Voorbeelden

Test een route vanuit een IoT Hub.

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

Test alle routes van het brontype DeviceMessages vanuit een IoT Hub.

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

Test alle route vanuit een IoT Hub met een aangepast bericht, inclusief hoofdtekst, app-eigenschappen en systeemeigenschappen.

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

Vereiste parameters

--hub-name -n

Naam van IoT Hub.

Optionele parameters

--ap --app-properties

App-eigenschappen van het routebericht.

--body -b

Hoofdtekst van het routebericht.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--rn --route --route-name

Naam van de route.

--source-type --type -t

Bron van de route.

Geaccepteerde waarden: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

--sp --system-properties

Systeemeigenschappen van het routebericht.

Globale parameters

--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az iot hub message-route update

Preview

Opdrachtgroep 'iot hub message-route' is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Werk een route voor een IoT Hub bij.

U kunt de bron-, eindpunt-, voorwaarde- of ingeschakelde status op de route wijzigen.

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

Voorbeelden

Werk een route bij naar een bepaald eindpunt en het brontype DeviceMessages.

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

Schakel een route uit.

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

Wijzig de voorwaarde van een route.

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

Vereiste parameters

--hub-name -n

Naam van IoT Hub.

--rn --route --route-name

Naam van de route.

Optionele parameters

--condition -c

Voorwaarde die wordt geëvalueerd om de routeringsregel toe te passen.

--en --endpoint --endpoint-name

Naam van het routeringseindpunt. Gebruik voor het ingebouwde eindpunt de eindpuntnaam 'gebeurtenissen'.

--enabled -e

Een Booleaanse waarde die aangeeft of route naar de IoT Hub moet worden ingeschakeld.

Geaccepteerde waarden: false, true

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--source-type --type -t

Bron van de route.

Geaccepteerde waarden: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

Globale parameters

--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.