Share via

az iot ops support

  • Preview
  • Reference

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

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

IoT Operations support operations.

Commands

Name Description Type Status
az iot ops support create-bundle

Creates a standard support bundle zip archive for use in troubleshooting and diagnostics.

 Extension Preview

az iot ops support create-bundle

Preview

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

Creates a standard support bundle zip archive for use in troubleshooting and diagnostics.

{Supported service APIs}

  • mqttbroker.iotoperations.azure.com/[v1beta1]
  • opcuabroker.iotoperations.azure.com/[v1beta1]
  • deviceregistry.microsoft.com/[v1beta2]
  • clusterconfig.azure.com/[v1]
  • connectivity.iotoperations.azure.com/[v1beta1]
  • arccontainerstorage.azure.net/[v1]
  • secret-sync.x-k8s.io/v1alpha1
  • secrets-store.csi.x-k8s.io/v1

Note: logs from evicted pod will not be captured, as they are inaccessible. For details on why a pod was evicted, please refer to the related pod and node files.

az iot ops support create-bundle [--broker-traces {false, true}]
                                 [--bundle-dir]
                                 [--context]
                                 [--log-age]
                                 [--ops-service {acs, akri, azuremonitor, billing, broker, dataflow, deviceregistry, opcua, schemaregistry, secretstore}]

Examples

Basic usage with default options. This form of the command will auto detect IoT Operations APIs and build a suitable bundle capturing the last 24 hours of container logs. The bundle will be produced in the current working directory.

az iot ops support create-bundle

Constrain data capture on a specific service as well as producing the bundle in a custom output dir.

az iot ops support create-bundle --ops-service opcua --bundle-dir ~/ops

Specify a custom container log age in seconds.

az iot ops support create-bundle --ops-service broker --log-age 172800

Include mqtt broker traces in the support bundle. This is an alias for stats trace fetch capability.

az iot ops support create-bundle --ops-service broker --broker-traces

Include arc container storage resources in the support bundle.

az iot ops support create-bundle --ops-service acs

Include secretstore resources in the support bundle.

az iot ops support create-bundle --ops-service secretstore

Include multiple services in the support bundle with single --ops-service flag.

az iot ops support create-bundle --ops-service broker opcua deviceregistry

Include multiple services in the support bundle with multiple --ops-service flags.

az iot ops support create-bundle --ops-service broker --ops-service opcua --ops-service deviceregistry

Optional Parameters

--broker-traces

Include mqtt broker traces in the support bundle. Usage may add considerable size to the produced bundle.

Accepted values: false, true
--bundle-dir

The local directory the produced bundle will be saved to. If no directory is provided the current directory is used.

--context

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

--log-age

Container log age in seconds.

Default value: 86400
--ops-service --svc

The IoT Operations service the support bundle creation should apply to. If no service is provided, the operation will default to capture all services. --ops-service can be used one or more times.

Accepted values: acs, akri, azuremonitor, billing, broker, dataflow, deviceregistry, opcua, schemaregistry, secretstore
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.