mcpField
E
eventstream-cli

eventstream-cli

github.com/microsoft数据与数据库1.3k97 次安装3 周前更新
代码仓库

关于 eventstream-cli

eventstream-cli 是用于管理 Fabric Eventstream 实时摄取拓扑的命令行技能,支持编写及只读检查。它涵盖来源、运算符、目标、路由、保留设置、吞吐量和健康状态。

主要功能

  1. 01创建和更新 Eventstream 拓扑
  2. 02管理来源、运算符和目标
  3. 03配置路由与保留设置
  4. 04检查吞吐量和节点健康状态
  5. 05暂停、恢复或删除 Eventstream

适用场景

  1. 01构建事件摄取拓扑
  2. 02添加或连接来源与目标
  3. 03检查拓扑健康状态和吞吐量
  4. 04查看保留设置和连接元数据

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/microsoft/skills-for-fabric --skill eventstream-cli

安装后在 Claude Code 中输入/eventstream-cli确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

apm.yml
references/
authoring.md
consumption.md

详细介绍

遥测 — 必须。 每次调用 api.fabric.microsoft.com 都必须携带 x-ms-fabric-skill: eventstream-cli(az rest:--headers "x-ms-fabric-skill=eventstream-cli"), 包括每次 LRO 轮询、fabric_lro 和重试。代码片段中省略了此项,但仍须添加。

重要说明

  1. 若要根据工作区名称查找工作区详细信息(包括其 ID):请列出所有工作区,然后使用 JMESPath 进行筛选。
  2. 若要根据工作区 ID、项类型和项名称查找项的详细信息(包括其 ID):请列出该工作区中该类型的所有项,然后使用 JMESPath 进行筛选。
  3. 技能区分:Eventstream 项本身——即事件如何从源流经运算符到达目标——请使用 eventstream-cli。数据进入 Eventhouse / KQL Database 后,若要查询或处理数据,请使用对应的 eventhouse-cli 模式;若要配置警报,请使用对应的 Activator 编写或使用技能。

Fabric Eventstream — CLI 技能

此技能负责 Fabric Eventstream 实时引入拓扑:源、运算符、目标、路由、保留和运行状况。

它是一个模式分派器,不包含任何操作流程。请从下表中选择与请求匹配的模式,然后在发出任何命令之前,使用文件读取工具从头到尾阅读对应的 references/<mode>.md 文件。该文件包含终结点、负载结构、模板和注意事项;不先阅读就开始操作会导致负载和结果出错。

模式选择

模式请求内容……触发示例首先阅读
authoring创建、更新、连接、暂停、恢复或删除 Eventstream 拓扑创建 eventstream、部署拓扑、添加源、添加筛选运算符、连接目标、更新定义references/authoring.md
consumption列出或检查 Eventstream、拓扑、保留、吞吐量、节点运行状况或 Custom Endpoint 连接元数据列出 eventstream、检查拓扑、eventstream 状态、保留、吞吐量、连接字符串references/consumption.md
模式边界规则

对于 Eventstream 定义和拓扑,consumption 为只读模式。创建、更新、删除、暂停或恢复 Eventstream 的请求需要使用 authoring:说明这一点,阅读 references/authoring.md,然后继续操作。

执行编写变更之前,先确定适用的源、目标、转换、保留和吞吐量要求。如果一般性请求未说明这些要求,请先提出一个简洁的澄清问题,再读取工作区状态或调用 API;不要自行编造拓扑。

如果请求确实涉及多个模式,请逐一处理,并在开始每部分操作之前阅读对应的参考文件。如果阅读此表后仍无法确定模式,请提出一个简短的澄清问题,不要猜测。

终结写入 — 不得跳过的步骤

阅读参考资料并规划拓扑并不代表任务已完成。每种变更模式都必须以一次状态变更调用结束。如果没有发出该调用,就没有任何内容被持久化——应明确说明这一点,而不是声称操作成功。

模式终结写入
authoring使用 POST /v1/workspaces/{ws}/items 或 /eventstreams 创建;使用 POST .../updateDefinition 持久化拓扑变更;使用不带正文的 POST .../pause,或携带必需 JSON startType 正文的 POST .../resume 控制生命周期;或者使用 DELETE .../eventstreams/{id} 删除项。构建或对 eventstream.json 进行 base64 编码不算写入。
consumption无——此模式为只读

报告编写任务已完成之前,请确认终结调用已成功返回,并在参考资料规定了验证步骤时,重新读取定义或运行时拓扑。

共享必备知识(所有模式)

先解析工作区和 Eventstream;所有模式都依赖它们。

任务参考资料备注
在 Fabric 中查找工作区和项COMMON-CLI.md必读——解析任何工作区或项 ID 前都要先阅读
Fabric 拓扑和关键概念COMMON-CORE.md项类型、工作区、容量
环境 URLCOMMON-CORE.md主权云/非公有云主机
身份验证和令牌获取COMMON-CORE.md受众错误会导致 401;遇到任何身份验证问题前都要先阅读
身份验证操作指南COMMON-CLI.mdaz login 流程和令牌获取
核心控制平面 REST APICOMMON-CORE.md分页、LRO 轮询、速率限制
常见问题和故障排除COMMON-CLI.mdaz rest 受众、Shell 转义、令牌过期

规则

必须
  • 在进行任何其他操作前,从上表中准确选择一种模式。
  • 在执行该模式的第一条命令前,先通过首次工具调用完整阅读 references/<mode>.md。
  • 通过列出并筛选来解析工作区和 Eventstream ID,绝不要猜测 GUID。
  • 请求涉及跨模式操作时,明确告知用户要切换模式。
  • 将参考资料视为操作说明,而不是交付内容。阅读后,针对实时工作区运行其中记录的命令,并报告实际结果。
  • 编写时,节点名称必须采用字母数字 PascalCase;平台生成的 DefaultStream 名称除外。
  • 获取 Custom Endpoint 凭据前,必须获得用户明确确认;除非用户在安全上下文中明确要求,否则绝不打印原始密钥或连接字符串。
优先
  • 选择满足请求所需的最精简模式。
  • 仅阅读一种模式的参考资料。只有请求确实涉及多个模式时才加载第二份,并在加载前说明原因。
  • 检查运行状况和连接时使用运行时拓扑;检查编写时的图结构和变更时使用解码后的定义。
避免
  • 仅凭此调度说明采取操作——此说明有意省略了操作细节。
  • 只总结参考资料而不执行其中的操作。
  • 在只读消费模式下进行任何修改。
  • 通过 Eventstream API 查询已落地的事件数据;只读 KQL 数据应使用 eventhouse-cli 消费模式。
  • 为此技能负责的工作加载其他技能(见 CRITICAL NOTES 3)。

示例

用户请求模式要阅读的参考资料
“创建一个包含 SampleData 源和 Lakehouse 目标的 Eventstream。”authoringreferences/authoring.md
“为我的 Eventstream 添加一个温度高于 30 的筛选器。”authoringreferences/authoring.md
“显示 SensorIngestion 中的所有源、运算符和目标。”consumptionreferences/consumption.md
“此 Eventstream 使用了哪些保留和吞吐量设置?”consumptionreferences/consumption.md

评论

支持 Markdown