az iot ops support
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 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 command space.
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
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}
- mq.iotoperations.azure.com/[v1beta1]
- opcuabroker.iotoperations.azure.com/[v1beta1]
- dataprocessor.iotoperations.azure.com/[v1]
- orchestrator.iotoperations.azure.com/[v1]
- akri.sh/[v0]
- layerednetworkmgmt.iotoperations.azure.com/[v1beta1]
- deviceregistry.microsoft.com/[v1beta1]
- clusterconfig.azure.com/[v1].
az iot ops support create-bundle [--bundle-dir]
[--context]
[--log-age]
[--mq-traces {false, true}]
[--ops-service {akri, auto, billing, dataprocessor, deviceregistry, lnm, mq, opcua, orc}]
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 mq --log-age 172800
Include mq traces in the support bundle. This is an alias for stats trace fetch capability.
az iot ops support create-bundle --ops-service mq --mq-traces
Optional Parameters
The local directory the produced bundle will be saved to. If no directory is provided the current directory is used.
Kubeconfig context name to use for k8s cluster communication. If no context is provided current_context is used.
Container log age in seconds.
Include mq traces in the support bundle. Usage may add considerable size to the produced bundle.
The IoT Operations service the support bundle creation should apply to. If auto is selected, the operation will detect which services are available.
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.
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for