get-support-data

重要

这是 Azure Sphere(旧版)文档。 Azure Sphere(旧版)将于 2027 年 9 月 27 日停用,用户此时必须迁移到 Azure Sphere(集成)。 使用位于 TOC 上方的版本选择器查看 Azure Sphere(集成)文档。

从计算机、云和附加的 Azure Sphere 设备收集并生成包含诊断和配置信息的日志文件。 这些日志文件中的信息可用于帮助你或技术支持团队分析和解决问题。 有关详细信息,请参阅 管理日志文件

必需的参数

参数 类型 描述
--目的地 文件名 指定要在其中保存支持数据的.zip文件的路径和文件名。 你可以提供相对或绝对路径。

可选参数

参数 类型 描述
-t、--tenant 字符串 指定要在其中执行此操作的租户。 替代默认选定的租户。 可以指定租户 ID 或租户名称。
全局参数

以下全局参数可用于 Azure Sphere CLI:

参数 说明
--debug 增加日志记录详细程度以显示所有调试日志。 如果发现了 bug,在提交 bug 报告时,请提供启用 --debug 标志生成的输出。
-h、--help 打印有关命令及其参数的 CLI 参考信息,并列出可用的子组和命令。
--only-show-errors 仅显示错误,禁止显示警告。
-o、--output 更改输出格式。 可用的输出格式为 json、jsonc(彩色 JSON)、tsv(制表分隔值)、表(人可读 ASCII 表)和 yaml。 默认情况下,CLI 输出 table。 若要详细了解可用的输出格式,请参阅 Azure Sphere CLI 命令的输出格式。
--query 使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。 有关详细信息和示例,请参阅 JMESPath 教程查询 Azure CLI 命令输出
--verbose 打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。 使用 --debug 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI,请参阅 全局参数 ,了解有关可用选项的详细信息。

示例

azsphere get-support-data --destination logs.zip
Gathering device data.
Gathering Azure Sphere Security Service data.
Gathering computer setup data.
Created the support log archive at 'logs.zip'.
Note: This archive contains information about your system including the list of Wi-Fi networks the device can see, installation logs, Azure Sphere command-line activity logs, attached USB devices, and Azure Sphere local and cloud configuration.
If you choose to provide this data to Microsoft, please send an email to azsppgsup@microsoft.com and attach the generated archive. All data will be handled according to the Microsoft Privacy Statement: go.microsoft.com/fwlink/?linkid=528096

注意

收集的数据可能包含要保持私密的信息。 查看表,以确定在共享日志文件之前,任何数据是否都应保持私密。

下表列出了生成的文件的详细信息,以及 azsphere get-support-data 命令尝试收集的信息

日志文件 说明
AzureSphere_ComputerSetup.log 记录与计算机相关的活动:
- Azure Sphere 内部配置设置。
- 所有本地网络适配器的 IP 地址。
- Azure Sphere 网络适配器的所有详细信息。
- Azure Sphere SLIP 服务的状态。
AzureSphere_Device_nnn.log 记录与附加设备相关的活动:
- 设备详细信息。
- 设备上安装的映像的状态。
- 设备上安装的设备组件和功能。
- 保存到设备的 Wi-Fi 网络。
- 设备的当前网络和接口状态。
- 设备中的 Wi-Fi 扫描结果。
- 设备上的当前 Wi-Fi 设置的状态。
- 设备的制造状态。
- 为防火墙设置的规则。
AzureSphere_DeviceLog_nnn.bin 包含附加设备的诊断数据,包括连接和设备状态信息。 Azure Sphere 示例库中提供了一个 Python 脚本,用于分析数据并将其以易于阅读的格式显示。
AzureSphere_DeviceTechSupportData_nnn.bin 包含附加设备的制造状态信息。
AzureSphere_SecurityService_nnn.log 记录有关 Azure Sphere 安全服务的信息:
- 当前配置,包括当前的 Azure Sphere 租户。
- Azure Sphere 租户列表。
- 云部署配置,包括设备组和产品。
- 云配置状态,包括云中提供的当前设备 OS 版本和当前 OS 版本。
ActivityLogs_AzureSphere.txt 包含有关命令运行的信息的日志文件。
InstallerLogs_AzureSphere 列出包含过去七天的 Azure Sphere 安装程序数据的日志文件。
InstallerLogs_VisualStudio 列出包含过去七天的 Visual Studio 安装程序数据的日志文件。