azure-web-pubsub
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseAzure Web PubSub Skill
Azure Web PubSub技能
This skill provides expert guidance for Azure Web PubSub. Covers troubleshooting, best practices, decision making, architecture & design patterns, limits & quotas, security, configuration, integrations & coding patterns, and deployment. It combines local quick-reference content with remote documentation fetching capabilities.
本技能为Azure Web PubSub提供专业指导,涵盖故障排查、最佳实践、决策指导、架构与设计模式、限制与配额、安全防护、配置、集成与编码模式以及部署等内容。它结合了本地快速参考内容与远程文档获取能力。
How to Use This Skill
如何使用本技能
IMPORTANT for Agent: Use the Category Index below to locate relevant sections. For categories with line ranges (e.g.,), useL35-L120with the specified lines. For categories with file links (e.g.,read_file), use[security.md](security.md)on the linked reference fileread_file
IMPORTANT for Agent: Ifis more than 3 months old, suggest the user pull the latest version from the repository. Ifmetadata.generated_attools are not available, suggest the user install it: Installation Guidemcp_microsoftdocs
This skill requires network access to fetch documentation content:
- Preferred: Use with query string
mcp_microsoftdocs:microsoft_docs_fetch. Returns Markdown.from=learn-agent-skill - Fallback: Use with query string
fetch_webpage. Returns Markdown.from=learn-agent-skill&accept=text/markdown
Agent注意事项:请使用下方的分类索引定位相关章节。对于带有行号范围的分类(如),使用L35-L120工具读取指定行内容。对于带有文件链接的分类(如read_file),使用[security.md](security.md)工具读取链接的参考文件read_file
本技能需要网络访问权限以获取文档内容:
- 优先方式:使用工具,查询字符串为
mcp_microsoftdocs:microsoft_docs_fetch,返回Markdown格式内容。from=learn-agent-skill - 备用方式:使用工具,查询字符串为
fetch_webpage,返回Markdown格式内容。from=learn-agent-skill&accept=text/markdown
Category Index
分类索引
| Category | Lines | Description |
|---|---|---|
| Troubleshooting | L37-L46 | Diagnosing and fixing Azure Web PubSub issues: local handler debugging, service/resource logs, common errors, and Socket.IO-specific troubleshooting and diagnostics. |
| Best Practices | L47-L51 | Guidance on building resilient WebSocket clients for Azure Web PubSub, including reconnection strategies, handling disconnects, error handling, and connection lifecycle best practices. |
| Decision Making | L52-L57 | Guidance on configuring Web PubSub for high availability with zones and understanding pricing, billing meters, and cost considerations |
| Architecture & Design Patterns | L58-L64 | Architectural patterns for Web PubSub: DR/resiliency design, bridging MQTT with Web PubSub, and understanding the internal Socket.IO support model. |
| Limits & Quotas | L65-L70 | Capacity and performance limits for Web PubSub (connections, messages, scaling) and which Socket.IO server APIs aren’t supported or behave differently. |
| Security | L71-L99 | Securing Azure Web PubSub: auth with Entra ID/managed identities/keys, mTLS, network & private endpoints, firewalls, policy/compliance, and language SDK identity setup. |
| Configuration | L100-L115 | Configuring Web PubSub behavior: monitoring/metrics, alerts, custom domains, event routing, geo-replication, client URLs, local tunneling, MQTT/Socket.IO specifics, and OData filters. |
| Integrations & Coding Patterns | L116-L146 | Client/server integration patterns for Azure Web PubSub: WebSocket/MQTT protocols, auth, REST, CloudEvents, reliable JSON/protobuf subprotocols, and SDK usage (.NET/Java/JS/Python, Functions, Socket.IO). |
| Deployment | L147-L153 | Guides for moving Web PubSub across regions, configuring Premium autoscale, and deploying/migrating Socket.IO apps and serverless chat to Azure Web PubSub. |
| 分类 | 行号 | 描述 |
|---|---|---|
| 故障排查 | L37-L46 | 诊断并修复Azure Web PubSub问题:本地处理程序调试、服务/资源日志、常见错误以及Socket.IO专属的故障排查与诊断。 |
| 最佳实践 | L47-L51 | 构建Azure Web PubSub高可用WebSocket客户端的指导,包括重连策略、断开连接处理、错误处理以及连接生命周期最佳实践。 |
| 决策指导 | L52-L57 | 配置Azure Web PubSub以实现区域高可用的指导,以及定价、计费计量和成本考量的相关说明 |
| 架构与设计模式 | L58-L64 | Azure Web PubSub的架构模式:灾难恢复/高可用设计、MQTT与Web PubSub的桥接、Socket.IO支持的内部模型解析。 |
| 限制与配额 | L65-L70 | Azure Web PubSub的容量与性能限制(连接数、消息数、扩缩容),以及Socket.IO服务器API中不支持或行为有差异的接口说明。 |
| 安全防护 | L71-L99 | Azure Web PubSub的安全配置:通过Entra ID/托管身份/密钥进行认证、mTLS、网络与专用终结点、防火墙、策略/合规性、语言SDK身份设置。 |
| 配置 | L100-L115 | Azure Web PubSub的行为配置:监控/指标、告警、自定义域名、事件路由、异地复制、客户端URL、本地隧道、MQTT/Socket.IO专属设置以及OData筛选器。 |
| 集成与编码模式 | L116-L146 | Azure Web PubSub的客户端/服务器集成模式:WebSocket/MQTT协议、认证、REST、CloudEvents、可靠JSON/protobuf子协议以及SDK使用(.NET/Java/JS/Python、Functions、Socket.IO)。 |
| 部署 | L147-L153 | Azure Web PubSub跨地域迁移指南、Premium层自动扩缩容配置、Socket.IO应用与无服务器聊天应用部署至Azure Web PubSub的相关指导。 |
Troubleshooting
故障排查
| Topic | URL |
|---|---|
| Debug Azure Web PubSub event handlers locally | https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-local-debug-event-handler |
| Troubleshoot common Azure Web PubSub issues | https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-troubleshoot-common-issues |
| Use Web PubSub resource logs for troubleshooting | https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-troubleshoot-resource-logs |
| Resolve common Azure Web PubSub service issues | https://learn.microsoft.com/en-us/azure/azure-web-pubsub/resource-faq |
| Troubleshoot Web PubSub for Socket.IO common issues | https://learn.microsoft.com/en-us/azure/azure-web-pubsub/socketio-troubleshoot-common-issues |
| Collect diagnostic logs for Web PubSub Socket.IO | https://learn.microsoft.com/en-us/azure/azure-web-pubsub/socketio-troubleshoot-logging |
| 主题 | 链接 |
|---|---|
| 本地调试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 |
| 使用Azure 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 |
| 排查Azure Web PubSub的Socket.IO常见问题 | https://learn.microsoft.com/en-us/azure/azure-web-pubsub/socketio-troubleshoot-common-issues |
| 收集Azure Web PubSub Socket.IO的诊断日志 | https://learn.microsoft.com/en-us/azure/azure-web-pubsub/socketio-troubleshoot-logging |
Best Practices
最佳实践
| Topic | URL |
|---|---|
| Design reliable WebSocket clients for Azure Web PubSub | https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-develop-reliable-clients |
| 主题 | 链接 |
|---|---|
| 为Azure Web PubSub设计高可用WebSocket客户端 | https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-develop-reliable-clients |
Decision Making
决策指导
| Topic | URL |
|---|---|
| Use availability zones and zone redundancy for Web PubSub | https://learn.microsoft.com/en-us/azure/azure-web-pubsub/concept-availability-zones |
| Understand Azure Web PubSub billing model | https://learn.microsoft.com/en-us/azure/azure-web-pubsub/concept-billing-model |
| 主题 | 链接 |
|---|---|
| 为Azure Web PubSub使用可用区域与区域冗余 | https://learn.microsoft.com/en-us/azure/azure-web-pubsub/concept-availability-zones |
| 了解Azure Web PubSub计费模型 | https://learn.microsoft.com/en-us/azure/azure-web-pubsub/concept-billing-model |
Architecture & Design Patterns
架构与设计模式
| Topic | URL |
|---|---|
| Design resilient and DR architectures for Web PubSub | https://learn.microsoft.com/en-us/azure/azure-web-pubsub/concept-disaster-recovery |
| Cross-protocol communication between MQTT and Web PubSub | https://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-mqtt-cross-protocol-communication |
| Internal design of Web PubSub for Socket.IO support | https://learn.microsoft.com/en-us/azure/azure-web-pubsub/socketio-service-internal |
| 主题 | 链接 |
|---|---|
| 为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 |
| Azure Web PubSub支持Socket.IO的内部设计 | https://learn.microsoft.com/en-us/azure/azure-web-pubsub/socketio-service-internal |
Limits & Quotas
限制与配额
| Topic | URL |
|---|---|
| Plan Web PubSub performance and capacity | https://learn.microsoft.com/en-us/azure/azure-web-pubsub/concept-performance |
| Unsupported Socket.IO server APIs in Web PubSub | https://learn.microsoft.com/en-us/azure/azure-web-pubsub/socketio-supported-server-apis |
| 主题 | 链接 |
|---|---|
| 规划Azure Web PubSub的性能与容量 | https://learn.microsoft.com/en-us/azure/azure-web-pubsub/concept-performance |
| Azure Web PubSub中不支持的Socket.IO服务器API | https://learn.microsoft.com/en-us/azure/azure-web-pubsub/socketio-supported-server-apis |
Security
安全防护
Configuration
配置
Integrations & Coding Patterns
集成与编码模式
Deployment
部署
| Topic | URL |
|---|---|
| Move Azure Web PubSub resources across regions | https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-move-across-regions |
| Configure autoscale for Azure Web PubSub Premium | https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-scale-autoscale |
| Deploy Socket.IO Serverless chat with Azure Functions | https://learn.microsoft.com/en-us/azure/azure-web-pubsub/socket-io-serverless-quickstart |
| Migrate self-hosted Socket.IO apps to Web PubSub | https://learn.microsoft.com/en-us/azure/azure-web-pubsub/socketio-migrate-from-self-hosted |
| 主题 | 链接 |
|---|---|
| 跨地域迁移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 |
| 将自托管Socket.IO应用迁移至Azure Web PubSub | https://learn.microsoft.com/en-us/azure/azure-web-pubsub/socketio-migrate-from-self-hosted |