azure-web-pubsub

Name: azure-web-pubsub
Author: microsoftdocs

github.com/microsoftdocs开发796172 次安装3 天前更新

代码仓库

关于 azure-web-pubsub

Azure Web PubSub Skill 为使用 Azure Web PubSub 的 Agent 提供指南，涵盖故障排查、架构、安全和开发集成，并结合本地速查内容与远程文档获取。

主要功能

01服务与事件处理程序故障排查
02WebSocket 客户端可靠性建议
03架构、容量与成本参考
04身份验证及网络安全指南
05SDK、REST、MQTT 与 Socket.IO 集成

适用场景

01排查 Web PubSub 服务或事件处理问题
02设计多区域和跨协议方案
03规划身份验证、权限与网络访问
04选择 SDK 或 REST 并集成客户端

MCP 相关

可通过 mcp_microsoftdocs 的 microsoft_docs_fetch 获取文档；也可使用 fetch_webpage 作为后备。

安装

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

$npx skills add https://github.com/microsoftdocs/agent-skills --skill azure-web-pubsub

安装后在 Claude Code 中输入/azure-web-pubsub确认已加载。

详细介绍

Azure Web PubSub 技能

此技能为 Azure Web PubSub 提供专业指导，涵盖故障排查、最佳实践、决策制定、架构与设计模式、限制与配额、安全性、配置、集成与编码模式以及部署。它结合了本地快速参考内容与远程文档获取功能。

如何使用此技能

IMPORTANT for Agent：使用下面的类别索引查找相关章节。对于带有行号范围的类别（例如，L35-L120），请使用 read_file 读取指定行。对于带有文件链接的类别（例如，[security.md](security.md)），请使用 read_file 读取链接的参考文件

IMPORTANT for Agent：如果 metadata.generated_at 的日期早于 3 个月以上，请建议用户从代码库拉取最新版本。如果没有可用的 mcp_microsoftdocs 工具，请建议用户安装该工具：安装指南

此技能需要网络访问权限才能获取文档内容：

首选：使用 mcp_microsoftdocs:microsoft_docs_fetch，并将 from=learn-agent-skill 作为查询字符串。返回 Markdown。
备用：使用 fetch_webpage，并将 from=learn-agent-skill&accept=text/markdown 作为查询字符串。返回 Markdown。

类别索引

类别	行号	说明
故障排查	L37-L47	诊断并修复 Web PubSub 错误、事件处理程序/调试问题、服务和 Socket.IO 问题，以及使用资源/诊断日志和错误代码进行故障排查。
最佳实践	L48-L52	关于为 Azure Web PubSub 构建弹性 WebSocket 客户端的指导，包括重新连接策略、处理断开连接、错误处理和连接生命周期最佳实践。
决策制定	L53-L59	关于选择聊天 SDK 还是 REST、为具体场景选择 Web PubSub 功能，以及了解定价、计费指标和成本影响的指导。
架构与设计模式	L60-L66	Web PubSub 的架构模式：多区域弹性、将 MQTT 与 WebSocket/Web PubSub 桥接，以及了解 Socket.IO 支持的内部机制以进行集成设计。
限制与配额	L67-L72	Web PubSub 的容量和性能限制（连接、消息、扩展），以及不受支持或行为有所不同的 Socket.IO 服务端 API。
安全性	L73-L101	保护 Azure Web PubSub：客户端和应用的身份验证/授权（密钥、Entra ID、身份、角色）、mTLS、网络/专用终结点、防火墙、出站限制，以及通过 Azure Policy 实现合规性。
配置	L102-L117	配置 Web PubSub 运行时：存储/聊天设置、指标/日志和警报、监控、自定义域、事件路由、异地复制、本地隧道、MQTT/Socket.IO 选项和管理 UI。
集成与编码模式	L118-L150	Azure Web PubSub 的客户端和服务端集成模式：SDK/REST 用法、WebSocket/MQTT、JSON/protobuf 子协议、身份验证、事件（HTTP/AMQP/Functions）以及 Socket.IO 集成。
部署	L151-L156	将 Web PubSub 跨区域迁移、配置 Premium 自动缩放，以及将 Socket.IO 应用和无服务器聊天部署到 Azure Web PubSub 或迁移到该服务的指南。

故障排除

主题	URL
解读 Azure Web PubSub 聊天错误代码	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/chat-reference-errors
在本地调试 Azure Web PubSub 事件处理程序	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-local-debug-event-handler
排查 Azure Web PubSub 常见问题	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-troubleshoot-common-issues
使用 Web PubSub 资源日志进行故障排除	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-troubleshoot-resource-logs
解决 Azure Web PubSub 服务常见问题	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/resource-faq
排查 Web PubSub for Socket.IO 常见问题	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/socketio-troubleshoot-common-issues
收集 Web PubSub Socket.IO 诊断日志	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/socketio-troubleshoot-logging

最佳实践

主题	URL
为 Azure Web PubSub 设计可靠的 WebSocket 客户端	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-develop-reliable-clients

决策

主题	URL
选择 Azure Web PubSub Chat SDK 或 REST API	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/chat-reference-sdk-and-rest
选择合适的 Azure Web PubSub 功能	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/choose-web-pubsub-capability
了解 Azure Web PubSub 计费模式	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/concept-billing-model

架构与设计模式

主题	URL
设计具有弹性的多区域 Azure Web PubSub	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/concept-disaster-recovery
MQTT 与 Web PubSub 之间的跨协议通信	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-mqtt-cross-protocol-communication
Web PubSub for Socket.IO 支持的内部设计	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/socketio-service-internal

限制与配额

主题	URL
规划 Web PubSub 性能和容量	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/concept-performance
Web PubSub 中不受支持的 Socket.IO 服务端 API	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/socketio-supported-server-apis

安全性

主题	URL
为 Azure Web PubSub 聊天客户端进行身份验证并颁发令牌	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/chat-howto-authenticate
为 Azure Web PubSub 聊天配置角色和权限	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/chat-howto-roles-permissions
使用 Microsoft Entra ID 授权访问 Web PubSub	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/concept-azure-ad-authorization
在 Azure Web PubSub 中配置通配符组角色权限	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/concept-wildcard-group-roles
使用 Entra 应用授权 Azure Web PubSub	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-authorize-from-application
使用托管标识授权 Azure Web PubSub	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-authorize-from-managed-identity
为 Web PubSub 启用客户端证书（mTLS）	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-client-certificate
配置 Azure Web PubSub 应用程序防火墙以控制客户端	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-configure-application-firewall
禁用 Azure Web PubSub 的基于密钥的身份验证	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-disable-local-auth
使用 Azure Application Gateway 保护 Web PubSub	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-integrate-app-gateway
使用 Azure Policy 审核 Azure Web PubSub 合规性	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-monitor-azure-policy
管理 Azure Web PubSub 网络访问控制规则	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-secure-network-access-control
使用专用终结点保护 Azure Web PubSub	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-secure-private-endpoints
安全轮换 Azure Web PubSub 访问密钥	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-secure-rotate-access-key
通过共享专用终结点保护 Web PubSub 发往 Azure Functions 的出站流量	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-secure-shared-private-endpoints
通过共享终结点从 Azure Web PubSub 私密访问 Key Vault	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-secure-shared-private-endpoints-key-vault
保护 Web PubSub 发往 Private Link Service 的出站流量	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-secure-shared-private-endpoints-private-link-service
使用 Azure Web PubSub 服务标记进行网络访问控制	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-service-tags
使用 Azure Identity 对 Web PubSub 客户端进行身份验证	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-use-azure-identity
在 Azure Web PubSub 中使用托管标识	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-use-managed-identity
将 Azure 内置 Policy 定义应用于 Web PubSub	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/policy-definitions
使用客户端身份验证构建无服务器 Web PubSub 聊天	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/quickstart-serverless
使用 Web PubSub for Socket.IO 进行身份验证	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/socketio-authentication
为 Azure Web PubSub 应用添加身份验证和权限	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/tutorial-permission
对 Azure Web PubSub 的 MQTT 客户端进行身份验证和授权	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/tutorial-upstream-auth-mqtt-client

配置

主题	URL
配置存储并启用 Azure Web PubSub Chat	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/chat-howto-enable-chat
使用 Azure Web PubSub 的指标和警报	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/concept-metrics
使用 Azure Monitor 配置 Azure Web PubSub 的监视	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-azure-monitor
为 Azure Web PubSub 配置自定义域名	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-custom-domain
配置 Azure Web PubSub 事件处理程序和路由	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-develop-eventhandler
为 Azure Web PubSub 启用异地复制	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-enable-geo-replication
Azure Web PubSub 监视指标和日志参考	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-monitor-data-reference
使用 Azure Web PubSub 本地隧道进行开发	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-web-pubsub-tunnel-tool
Web PubSub MQTT 处理程序的 CloudEvents 扩展	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-mqtt-cloud-events
为 Web PubSub 编写 OData 筛选表达式	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-odata-filter
配置 Azure Web PubSub Socket.IO 无服务器协议	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/socket-io-serverless-protocol
使用 Azure Socket.IO Admin UI 进行监视	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/socketio-troubleshoot-admin-ui

集成与编码模式

主题	URL
通过 SDK 和 REST 管理 Azure Web PubSub 聊天室	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/chat-howto-manage-rooms
在 Azure Web PubSub 聊天中发送和管理消息	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/chat-howto-messages
将 MQTT 和 WebSocket 客户端连接到 Azure Web PubSub	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-connect-mqtt-websocket-client
配置 Azure Web PubSub 客户端事件以发送到 Event Hubs	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-develop-event-listener
生成 Azure Web PubSub 客户端访问 URL	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-generate-client-access-url
为 Azure Web PubSub 事件实现上游服务	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-web-pubsub-write-upstream-server
创建 WebSocket 客户端	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-websocket-connect
使用 Azure Web PubSub 的 C# 客户端 SDK	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-client-sdk-csharp
使用 Azure Web PubSub 的 Java 客户端 SDK	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-client-sdk-java
使用 Azure Web PubSub 的 JavaScript 客户端 SDK	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-client-sdk-javascript
使用 Azure Web PubSub 的 Python 客户端 SDK	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-client-sdk-python
遵循 Azure Web PubSub 客户端规范	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-client-specification
通过 HTTP CloudEvents 处理 Web PubSub 事件	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-cloud-events
通过 AMQP CloudEvents 处理 Web PubSub 事件	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-cloud-events-amqp
在 Azure Functions 中使用 Web PubSub 触发器和绑定	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-functions-bindings
为 Web PubSub 实现可靠的 JSON WebSocket 子协议	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-json-reliable-webpubsub-subprotocol
使用 Azure Web PubSub JSON WebSocket 子协议	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-json-webpubsub-subprotocol
为 Web PubSub 实现可靠的 protobuf WebSocket 子协议	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-protobuf-reliable-webpubsub-subprotocol
使用 Azure Web PubSub protobuf WebSocket 子协议	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-protobuf-webpubsub-subprotocol
使用 Azure Web PubSub 数据平面 REST API	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-rest-api-data-plane
Azure Web PubSub 中 MQTT 的 REST API 语义	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-rest-api-mqtt
使用 Azure Web PubSub 的 .NET 服务端 SDK	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-server-sdk-csharp
使用 Azure Web PubSub 的 Java 服务端 SDK	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-server-sdk-java
使用 Azure Web PubSub 的 JavaScript 服务端 SDK	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-server-sdk-js
使用 Azure Web PubSub 的 Python 服务端 SDK	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-server-sdk-python
对 Azure Web PubSub 进行身份验证并连接	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/samples-authenticate-and-connect
将 Web PubSub for Socket.IO 与 API Management 集成	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/socket-io-howto-integrate-apim
使用 Socket.IO Azure Functions 触发器和绑定	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/socket-io-serverless-function-binding
将 Web PubSub for Socket.IO 集成到现有应用中	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/socketio-quickstart

部署

主题	URL
在不同区域间迁移 Azure Web PubSub 资源	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-move-across-regions
为 Azure Web PubSub Premium 配置自动缩放	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-scale-autoscale
使用 Azure Functions 部署 Socket.IO 无服务器聊天	https://learn.microsoft.com/en-us/azure/azure-web-pubsub/socket-io-serverless-quickstart

支持 Markdown

登录后评论

基本信息

作者: microsoftdocs
仓库: microsoftdocs/agent-skills
分类: 开发
安装次数: 172
GitHub Stars: 796

报告问题