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 |
Mqtt broker authentication management. |
Extension | GA |
az iot ops broker authn apply |
Create or replace an mqtt broker authentication resource. |
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 a broker. |
Extension | GA |
az iot ops broker authn method |
Mqtt broker authn method operations. |
Extension | GA |
az iot ops broker authn method add |
Add authentication methods to an mqtt broker authentication resource. |
Extension | GA |
az iot ops broker authn show |
Show details of an mqtt broker authentication resource. |
Extension | GA |
az iot ops broker authz |
Mqtt broker authorization management. |
Extension | GA |
az iot ops broker authz apply |
Create or replace an mqtt broker authorization resource. |
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 a broker. |
Extension | GA |
az iot ops broker authz show |
Show details of an mqtt broker authorization resource. |
Extension | GA |
az iot ops broker list |
List mqtt brokers associated with an instance. |
Extension | GA |
az iot ops broker listener |
Mqtt broker listener management. |
Extension | GA |
az iot ops broker listener apply |
Create or replace an mqtt broker listener service. |
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 port |
Mqtt broker listener port operations. |
Extension | GA |
az iot ops broker listener port add |
Add a tcp port config to an mqtt broker listener service. |
Extension | GA |
az iot ops broker listener port remove |
Remove a tcp port config from an mqtt broker listener service. |
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 list
List mqtt brokers associated with an instance.
az iot ops broker list --instance
--resource-group
Examples
Enumerate all mqtt brokers in the instance.
az iot ops broker list --in myinstance -g myresourcegroup
Required Parameters
IoT Operations instance name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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 instance mqtt broker.
az iot ops broker show -n default --in myinstance -g myresourcegroup
Required Parameters
IoT Operations instance name.
Broker name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.