az iot ops mq

  • Preview
  • Reference

Note

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

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

MQ specific tools.

Commands

Name Description Type Status
az iot ops mq get-password-hash

Generates a PBKDF2 hash of the passphrase applying PBKDF2-HMAC-SHA512. A 128-bit salt is used from os.urandom.

 Extension Preview
az iot ops mq stats

Show dmqtt running statistics.

 Extension Preview

az iot ops mq get-password-hash

Preview

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

Generates a PBKDF2 hash of the passphrase applying PBKDF2-HMAC-SHA512. A 128-bit salt is used from os.urandom.

az iot ops mq get-password-hash --phrase
                                [--iterations]

Examples

Produce a hash of the phrase 'mypassphrase' using the default number of hash iterations.

az iot ops mq get-password-hash -p mypassphrase

Required Parameters

--phrase -p

Passphrase to apply hashing algorithm to.

Optional Parameters

--iterations -i

Using a higher iteration count will increase the cost of an exhaustive search but will also make derivation proportionally slower.

default value: 210000
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 mq stats

Preview

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

Show dmqtt running statistics.

{Supported service APIs}

  • mq.iotoperations.azure.com/v1beta1.
az iot ops mq stats [--context]
                    [--metrics-port]
                    [--namespace]
                    [--protobuf-port]
                    [--raw {false, true}]
                    [--refresh]
                    [--trace-dir]
                    [--trace-ids]
                    [--watch {false, true}]

Examples

Fetch key performance indicators from the diagnostics Prometheus metrics endpoint.

az iot ops mq stats

Same as prior example except with a dynamic display that refreshes periodically.

az iot ops mq stats --watch

Return the raw output of the metrics endpoint with minimum processing.

az iot ops mq stats --raw

Fetch all available mq traces from the diagnostics Protobuf endpoint. This will produce a `.zip` with both `Otel` and Grafana `tempo` file formats. A trace files last modified attribute will match the trace timestamp.

az iot ops mq stats --trace-dir .

Fetch traces by trace Ids provided in space-separated hex format. Only `Otel` format is shown.

az iot ops mq stats --trace-ids 4e84000155a98627cdac7de46f53055d

Optional Parameters

--context

Kubeconfig context name to use for k8s cluster communication. If no context is provided current_context is used.

--metrics-port

Diagnostic service metrics API port.

default value: 9600
--namespace -n

K8s cluster namespace the command should operate against. If no namespace is provided the kubeconfig current_context namespace will be used. If not defined, the fallback value azure-iot-operations will be used.

--protobuf-port

Diagnostic service protobuf API port.

default value: 9800
--raw

Return raw output from the metrics API.

accepted values: false, true
--refresh

Number of seconds between a stats refresh. Applicable with --watch.

default value: 10
--trace-dir

Local directory where traces will be bundled and stored at.

--trace-ids

Space-separated trace ids in hex format.

--watch

The operation blocks and dynamically updates a stats table.

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.