az iot ops broker authz
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 authz 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 authorization management.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az iot ops broker authz delete |
Delete an mqtt broker authorization resource. |
Extension | Preview |
| az iot ops broker authz list |
List mqtt broker authorization resources associated with an instance. |
Extension | Preview |
| az iot ops broker authz show |
Show details of an mqtt broker authorization resource. |
Extension | Preview |
az iot ops broker authz delete
Command group 'iot ops' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Delete an mqtt broker authorization resource.
az iot ops broker authz delete --broker
--instance
--name
--resource-group
[--yes {false, true}]Examples
Delete the broker authorization resource called 'authz' associated with broker 'broker'.
az iot ops broker authz delete -n authz -b broker --in mycluster-ops-instance -g myresourcegroupSame as prior example but skipping the confirmation prompt.
az iot ops broker authz delete -n authz -b broker --in mycluster-ops-instance -g myresourcegroup -yRequired Parameters
Mqtt broker name.
IoT Operations instance name.
Mqtt broker authorization resource name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Confirm [y]es without a prompt. Useful for CI and automation scenarios.
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 authz list
Command group 'iot ops' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
List mqtt broker authorization resources associated with an instance.
az iot ops broker authz list --broker
--instance
--resource-groupExamples
Enumerate all broker authorization resources associated with the default broker.
az iot ops broker authz list -b broker --in mycluster-ops-instance -g myresourcegroupRequired Parameters
Mqtt broker name.
IoT Operations instance name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
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 authz show
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 authorization resource.
az iot ops broker authz show --broker
--instance
--name
--resource-groupExamples
Show details of a broker authorization resource 'authz' associated with the default broker.
az iot ops broker authz show -n authz -b broker --in mycluster-ops-instance -g myresourcegroupRequired Parameters
Mqtt broker name.
IoT Operations instance name.
Mqtt broker authorization resource name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
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.
Azure CLI