az iot ops broker authn

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 authn 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 authentication management.

Commands

Name	Description	Type	Status
az iot ops broker authn delete	Delete an mqtt broker authentication resource.	Extension	Preview
az iot ops broker authn list	List mqtt broker authentication resources associated with an instance.	Extension	Preview
az iot ops broker authn show	Show details of an mqtt broker authentication resource.	Extension	Preview

az iot ops broker authn delete

Preview

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

Delete an mqtt broker authentication resource.

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

Examples

Delete the broker authentication resource called 'authn' associated with broker 'broker'.

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

Same as prior example but skipping the confirmation prompt.

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

Required Parameters

--broker -b

Mqtt broker name.

--instance -i

IoT Operations instance name.

--name -n

Mqtt broker authentication resource 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 authn list

Preview

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

List mqtt broker authentication resources associated with an instance.

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

Examples

Enumerate all broker authentication resources associated with the default broker.

az iot ops broker authn 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 authn 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 authentication resource.

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

Examples

Show details of the default broker authentication resource 'authn' associated with the default broker.

az iot ops broker authn show -n authn -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 authentication resource 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.