Share via

az iot hub message-route fallback

  • Preview

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.67.0 or higher). The extension will automatically install the first time you run an az iot hub message-route fallback command. Learn more about extensions.

Command group 'iot hub message-route' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage the fallback route of an IoT hub.

Commands

Name Description Type Status
az iot hub message-route fallback set

Enable or disable the fallback route in an IoT Hub.

 Extension Preview
az iot hub message-route fallback show

Show the fallback route of an IoT Hub.

 Extension Preview

az iot hub message-route fallback set

Preview

Command group 'iot hub message-route' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Enable or disable the fallback route in an IoT Hub.

az iot hub message-route fallback set --enabled {false, true}
                                      [--hub-name]
                                      [--ids]
                                      [--resource-group]
                                      [--subscription]

Examples

Enable the fallback route in an IoT Hub

az iot hub message-route fallback set -n {iothub_name} --enabled true

Disable the fallback route in an IoT Hub.

az iot hub message-route fallback set -n {iothub_name} --enabled false

Required Parameters

--enabled -e

A boolean indicating whether to enable route to the IoT Hub.

Property Value
Accepted values: false, true

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--hub-name -n

IoT Hub name.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az iot hub message-route fallback show

Preview

Command group 'iot hub message-route' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show the fallback route of an IoT Hub.

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

Examples

Show the fallback route from an IoT Hub.

az iot hub message-route fallback show -n {iothub_name}

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--hub-name -n

IoT Hub name.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False