Display device information
An Azure Sphere catalog can contain thousands of devices, and managing the devices requires a method to obtain detailed information about each of them. Using the CLI commands, you can list information about devices, products, and device groups in a catalog.
You can also use the CLI commands to download diagnostic and configuration information, data about the errors, and other events that affect your devices.
The commands used to obtain support information will depend on whether you are gathering customer support data for a single Azure Sphere device when working with Microsoft support, or returning data on error conditions involving the applications running on devices within a catalog. In most scenarios, you will be querying the catalog for error conditions on all devices using the az sphere catalog download-error-report command. This method will depend on the Azure Sphere Security Service communication with the devices through an internet connection to gather the matching events.
The az sphere get-support-data command gathers and generates log files containing diagnostic and configuration information from your computer, the cloud, and the attached Azure Sphere device. The information in these log files can be used to help you or the technical support team to analyze and troubleshoot problems.
Use the --output-file parameter to specify the path and filename of the .zip file in which to save the support data. You can provide a relative or absolute path.
Notes
The collected data might contain information you wish to keep private. Review the table to determine whether any of the data should remain private before you share the log files.
The following table lists the details of the generated files and information the az sphere get-support-data command tries to gather:
| Log file | Description |
|---|---|
| AzureSphere_ComputerSetup.log | Records activities related to the computer: - Azure Sphere internal configuration settings. - IP addresses of all local network adapters. - All details of the Azure Sphere network adapters. - The status of the Azure Sphere SLIP service. |
| AzureSphere_Device_nnn.log | Records activities related to the attached device: - Device details. - Status of images installed on device. - Device components and capabilities installed on the device. - Wi-Fi networks saved to device. - The current network and interface status of the device. - Wi-Fi scan results from device. - Status of the current Wi-Fi setup on the device. - Manufacturing state of the device. - Rules set for the firewall. |
| AzureSphere_DeviceLog_nnn.bin | Contains information for the attached device. |
| AzureSphere_DeviceTechSupportData_nnn.bin | Contains manufacturing state information for the attached device. |
| AzureSphere_SecurityService_nnn.log | Records information about the Azure Sphere security service: - The current configuration, including the current Azure Sphere catalog. - List of Azure Sphere catalog. - Cloud deployment configuration, including device group and product. - Cloud configuration status, including current device OS version and current OS version available from the cloud. |
| ActivityLogs_AzureSphere.txt | A log file containing information about the executed commands. |
| InstallerLogs_AzureSphere | Lists log files containing the last seven days' Azure Sphere installer data. |
| InstallerLogs_VisualStudio | Lists log files containing the last seven days' Visual Studio installer data. |
The az sphere catalog download-error-report command returns information on errors reported by devices within a catalog. Event data is pulled from the Azure Sphere Security Service cloud and does not require a physical connection to a particular device. The command works in the context of the current catalog and returns error reports for all devices within that catalog.
Use the --output-file parameter to specify the path and filename of the .csv file in which to save the support data. You can provide a relative or absolute path.