Azure Sentinel工作簿元数据文件使用指南

工作簿元数据文件的作用

在Azure Sentinel项目中，工作簿(Workbook)的元数据管理是一个重要环节。工作簿元数据文件(workbooksMetadata.json)作为集中管理所有工作簿元信息的配置文件，主要承担以下功能：

1. 版本控制：记录每个工作簿的当前版本号，便于追踪更新历史
2. 分类管理：对工作簿进行分类标识，方便用户查找和使用
3. 依赖关系管理：记录工作簿之间的依赖关系
4. 兼容性信息：标明工作簿适用的Azure Sentinel版本范围

元数据文件的使用规范

项目中的workbooksMetadata.json文件位于Workbooks目录下，开发者不应在各自的工作簿子目录中创建新的元数据文件，而是应该统一更新这个主元数据文件。

当开发者提交新的工作簿或更新现有工作簿时，需要：

1. 在主元数据文件中添加或更新对应工作簿的条目
2. 确保版本号按照语义化版本规范进行递增
3. 提供清晰的工作簿描述信息
4. 正确设置工作簿的分类标签

版本管理最佳实践

工作簿的版本管理应遵循以下原则：

1. 主版本号(Major)：当有不兼容的API修改时递增
2. 次版本号(Minor)：当新增向下兼容的功能时递增
3. 修订号(Patch)：当进行向下兼容的问题修正时递增

每次对工作簿进行功能性修改后，都应在元数据文件中更新版本号，确保用户能够清晰了解工作簿的演进过程。

常见问题解答

虽然不推荐在工作簿子目录中创建单独的元数据文件，但有些开发者可能会有这样的疑问。实际上，集中式的元数据管理更有利于维护和查询，也能避免重复和冲突。

对于版本更新的具体操作，开发者只需在主元数据文件中找到对应工作簿的条目，修改version字段即可。这种集中管理的方式简化了版本控制流程，也便于自动化工具进行处理。