az iot ops broker listener

Note

This reference is part of the azure-iot-ops extension for the Azure CLI (version 2.53.0 or higher). The extension will automatically install the first time you run an az iot ops broker listener command. Learn more about extensions.

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

Broker listener management.

Commands

Name	Description	Type	Status
az iot ops broker listener list	List mqtt broker listeners associated with a broker.	Extension	Preview
az iot ops broker listener show	Show details of an mqtt broker listener.	Extension	Preview

az iot ops broker listener list

Preview

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

List mqtt broker listeners associated with a broker.

az iot ops broker listener list --broker
                                --instance
                                --resource-group

Examples

Enumerate all broker listeners associated with the default broker.

az iot ops broker listener list -b broker --in mycluster-ops-instance -g myresourcegroup

Required Parameters

--broker -b

Mqtt broker name.

--instance -i

IoT Operations instance name.

--resource-group -g

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az iot ops broker listener show

Preview

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

Show details of an mqtt broker listener.

az iot ops broker listener show --broker
                                --instance
                                --name
                                --resource-group

Examples

Show details of the default listener 'listener' associated with the default broker.

az iot ops broker listener show -n listener -b broker --in mycluster-ops-instance -g myresourcegroup

Required Parameters

--broker -b

Mqtt broker name.

--instance -i

IoT Operations instance name.

--name -n

Mqtt broker listener name.

--resource-group -g

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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