az iot ops broker

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 command. Learn more about extensions.

Mqtt broker management.

Commands

Name	Description	Type	Status
az iot ops broker authn	Broker authentication management.	Extension	GA
az iot ops broker authn delete	Delete an mqtt broker authentication resource.	Extension	GA
az iot ops broker authn list	List mqtt broker authentication resources associated with an instance.	Extension	GA
az iot ops broker authn show	Show details of an mqtt broker authentication resource.	Extension	GA
az iot ops broker authz	Broker authorization management.	Extension	GA
az iot ops broker authz delete	Delete an mqtt broker authorization resource.	Extension	GA
az iot ops broker authz list	List mqtt broker authorization resources associated with an instance.	Extension	GA
az iot ops broker authz show	Show details of an mqtt broker authorization resource.	Extension	GA
az iot ops broker delete	Delete an mqtt broker.	Extension	GA
az iot ops broker list	List mqtt brokers associated with an instance.	Extension	GA
az iot ops broker listener	Broker listener management.	Extension	GA
az iot ops broker listener delete	Delete an mqtt broker listener.	Extension	GA
az iot ops broker listener list	List mqtt broker listeners associated with a broker.	Extension	GA
az iot ops broker listener show	Show details of an mqtt broker listener.	Extension	GA
az iot ops broker show	Show details of an mqtt broker.	Extension	GA

az iot ops broker delete

Delete an mqtt broker.

az iot ops broker delete --instance
                         --name
                         --resource-group
                         [--yes {false, true}]

Examples

Delete the broker called 'broker' in the instance 'mycluster-ops-instance'.

az iot ops broker delete -n broker --in mycluster-ops-instance -g myresourcegroup

Same as prior example but skipping the confirmation prompt.

az iot ops broker delete -n broker --in mycluster-ops-instance -g myresourcegroup -y

Required Parameters

--instance -i

IoT Operations instance name.

--name -n

Mqtt broker name.

--resource-group -g

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

Optional Parameters

--yes -y

Confirm [y]es without a prompt. Useful for CI and automation scenarios.

Accepted values: false, true

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 list

List mqtt brokers associated with an instance.

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

Examples

Enumerate all brokers in the instance 'mycluster-ops-instance'.

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

Required Parameters

--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 show

Show details of an mqtt broker.

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

Examples

Show details of the default broker 'broker' in the instance 'mycluster-ops-instance'.

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

Required Parameters

--instance -i

IoT Operations instance name.

--name -n

Mqtt broker 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.