SuperAPI AI 工具集

onelake-catalog-cli

数据与分析

查看项目

更新于 10-30 15:23

技能介绍

OneLake Catalog CLI 是 Microsoft Fabric 的一个技能模块,用于治理和策展 OneLake 目录。它通过 Fabric Admin、Core 和 Power BI REST API,提供租户级或数据所有者级的目录管理能力,核心围绕健康、保护和信任三个支柱。该技能采用模式调度器设计,根据请求类型加载不同的参考文档执行,所有模式共享认证、分页、长运行操作(LRO)和速率限制等基础要求。

【用途与模式】 技能分为策展(curate)和治理(govern)两类模式。治理模式进一步按权限层和动作划分为四种:dataowner-audit(非管理员的工作区或域所有者审计其可管理的工作区,只读)、dataowner-remediate(数据所有者同时是域/工作区/容量管理员时修复治理发现,可写)、admin-audit(Fabric 租户管理员审计租户级治理状况,只读)、admin-remediate(租户管理员执行租户级写操作,可写)。策展模式用于所有者改进特定条目的可发现性元数据,包括条目的描述、显示名称、标签,以及表/列描述(仅适用于含 OneLake Tables 文件夹的条目),每次操作一个条目、一个明确列表或一个指定工作区。

【主要能力】 策展模式:支持修改条目描述、显示名称(SQL 数据库的显示名称创建后不可更改),应用或移除条目标签;对于包含表/列的条目,可写入表和列描述(写入时会替换整个附加元数据,需重新读取并发送完整集合)。每次变更前需所有者查看当前→建议预览并明确批准。 治理审计:dataowner-audit 使用 Core API 审计调用者可访问工作区的治理状况(如描述和标签覆盖率),并注明范围、分母和新鲜度警告;admin-audit 使用 /v1/admin/* 接口进行租户级审计。审计模式只读,不执行任何写操作。 治理修复:dataowner-remediate 支持单工作区域分配、容量分配、工作区标签、刷新、条目身份等操作(需相应管理员权限,202 需轮询至终态);admin-remediate 支持域管理、批量工作区分配、域角色、标签、租户标签定义和租户设置等写操作,每类写操作均有明确的前置检查门槛(如删除域前需检查子域和关联工作区,批量分配前需检查当前域并警告覆盖,批量标签变更需试运行并确认,租户设置需先展示当前值)。

【使用方式】 所有 Fabric API 调用必须携带 x-ms-fabric-skill: onelake-catalog-cli 请求头。工作区 ID 和条目 ID 可通过单次 az rest 查询获取。读写操作需遵循模式边界:策展是条目元数据的唯一写入者;治理先审计后修复;审计模式禁止写入。获取条目定义使用 getDefinition 接口,需处理 202 长运行操作并按 Retry-After 等待(通常 20-30 秒,建议命令超时设为 3 分钟)。写操作完成后需确认显式成功(200/201 或 LRO 终态成功)并回读结果。

【适用场景与限制】 适用于 Fabric 租户管理员、域/工作区/容量管理员及数据所有者进行目录健康审计、元数据策展和受控修复。已知限制包括:非租户管理员的域/工作区管理员无法通过 /v1/admin/* 获取其作用域治理状况,Core API 也无法列出域内工作区;背书、DLP 策略、所有者更改敏感度标签、租户管理员删除条目等操作没有写 API,技能会明确说明并指出可操作角色;条目发现(未知工作区时查找条目)属于 search-consumption-cli 的范畴,不在本技能内。