← LeaderboardThe Skill Leaderboard

azure-web-pubsub

Expert knowledge for Azure Web PubSub development including troubleshooting, best practices, decision making, architecture & design patterns, limits & quotas, security, configuration, integrations & coding patterns, and deployment. Use when building WebSocket/MQTT apps, Socket.IO chat, geo-replicated hubs, custom domains, or autoscale deployments, and other Azure Web PubSub related development tasks. Not for Azure SignalR Service (use azure-signalr-service), Azure Event Hubs (use azure-event-hubs), Azure Service Bus (use azure-service-bus).

Published by MicrosoftDocs ↗MicrosoftDocs/Agent-Skills

Try your first task

azure-web-pubsub

Start a fresh conversation. Replace the highlighted placeholders.

Use azure-web-pubsub to design a [WebSocket/MQTT application architecture] for [specific use case, e.g., real-time chat or IoT telemetry], providing guidance on security (authN/Z), event routing configuration, and the selection of appropriate client SDKs or REST APIs based on [performance/scaling requirements].

Required inputs

  • [WebSocket/MQTT application architecture]
  • [specific use case, e.g., real-time chat or IoT telemetry]
  • [performance/scaling requirements]

User-approved starter prompt based on a pinned source version; check current skill requirements before running. Task evidence ↗

SKILL.md

name: azure-web-pubsubdescription: Expert knowledge for Azure Web PubSub development including troubleshooting, best practices, decision making, architecture & design patterns, limits & quotas, security, configuration, integrations & coding patterns, and deployment. Use when building WebSocket/MQTT apps, Socket.IO chat, geo-replicated hubs, custom domains, or autoscale deployments, and other Azure Web PubSub related development tasks. Not for Azure SignalR Service (use azure-signalr-service), Azure Event Hubs (use azure-event-hubs), Azure Service Bus (use azure-service-bus).compatibility: Requires network access. Uses mcp_microsoftdocs:microsoft_docs_fetch or fetch_webpage to retrieve documentation.metadata:   generated_at: "2026-10-18"  generator: "docs2skills/1.0.0"

Azure Web PubSub Skill

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.

How to Use This Skill

IMPORTANT for Agent: Use the Category Index below to locate relevant sections. For categories with line ranges (e.g., L35-L120), use read_file with the specified lines. For categories with file links (e.g., [security.md](security.md)), use read_file on the linked reference file

IMPORTANT for Agent: If metadata.generated_at is more than 3 months old, suggest the user pull the latest version from the repository. If mcp_microsoftdocs tools are not available, suggest the user install it: Installation Guide

This skill requires network access to fetch documentation content:

  • Preferred: Use mcp_microsoftdocs:microsoft_docs_fetch with query string from=learn-agent-skill. Returns Markdown.
  • Fallback: Use fetch_webpage with query string from=learn-agent-skill&accept=text/markdown. Returns Markdown.

Category Index

CategoryLinesDescription
TroubleshootingL37-L47Diagnosing and fixing Web PubSub errors, event handler/debug issues, service and Socket.IO problems, using resource/diagnostic logs and error codes for troubleshooting.
Best PracticesL48-L52Guidance on building resilient WebSocket clients for Azure Web PubSub, including reconnection strategies, handling disconnects, error handling, and connection lifecycle best practices.
Decision MakingL53-L59Guidance on choosing chat SDK vs REST, selecting Web PubSub features for your scenario, and understanding pricing, billing meters, and cost implications.
Architecture & Design PatternsL60-L66Architectural patterns for Web PubSub: multi-region resiliency, bridging MQTT with WebSocket/Web PubSub, and understanding Socket.IO support internals for integration design.
Limits & QuotasL67-L72Capacity and performance limits for Web PubSub (connections, messages, scaling) and which Socket.IO server APIs aren’t supported or behave differently.
SecurityL73-L101Securing Azure Web PubSub: authN/Z for clients and apps (keys, Entra ID, identities, roles), mTLS, network/private endpoints, firewalls, outbound restrictions, and compliance via Azure Policy.
ConfigurationL102-L117Configuring Web PubSub runtime: storage/chat setup, metrics/logs and alerts, monitoring, custom domains, event routing, geo-replication, local tunneling, MQTT/Socket.IO options, and admin UI.
Integrations & Coding PatternsL118-L150Client and server integration patterns for Azure Web PubSub: SDK/REST usage, WebSocket/MQTT, JSON/protobuf subprotocols, auth, events (HTTP/AMQP/Functions), and Socket.IO integration.
DeploymentL151-L156Guides for moving Web PubSub across regions, configuring Premium autoscale, and deploying/migrating Socket.IO apps and serverless chat to Azure Web PubSub.

Troubleshooting

Best Practices

TopicURL
Design reliable WebSocket clients for Azure Web PubSubhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-develop-reliable-clients

Decision Making

Architecture & Design Patterns

Limits & Quotas

Security

TopicURL
Authenticate and issue tokens for Azure Web PubSub chat clientshttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/chat-howto-authenticate
Configure roles and permissions for Azure Web PubSub chathttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/chat-howto-roles-permissions
Authorize Web PubSub access with Microsoft Entra IDhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/concept-azure-ad-authorization
Configure wildcard group role permissions in Azure Web PubSubhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/concept-wildcard-group-roles
Authorize Azure Web PubSub with Entra applicationshttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-authorize-from-application
Authorize Azure Web PubSub using managed identitieshttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-authorize-from-managed-identity
Enable client certificate (mTLS) for Web PubSubhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-client-certificate
Configure Azure Web PubSub Application Firewall for client controlhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-configure-application-firewall
Disable key-based auth for Azure Web PubSubhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-disable-local-auth
Secure Web PubSub with Azure Application Gatewayhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-integrate-app-gateway
Audit Azure Web PubSub compliance with Azure Policyhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-monitor-azure-policy
Manage Azure Web PubSub network access control ruleshttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-secure-network-access-control
Secure Azure Web PubSub with private endpointshttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-secure-private-endpoints
Rotate Azure Web PubSub access keys safelyhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-secure-rotate-access-key
Secure Web PubSub outbound traffic to Azure Functions via shared private endpointshttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-secure-shared-private-endpoints
Access Key Vault privately from Azure Web PubSub via shared endpointshttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-secure-shared-private-endpoints-key-vault
Secure Web PubSub outbound traffic to Private Link Servicehttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-secure-shared-private-endpoints-private-link-service
Use Azure Web PubSub service tags for network access controlhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-service-tags
Authenticate Web PubSub clients with Azure Identityhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-use-azure-identity
Use managed identities with Azure Web PubSubhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-use-managed-identity
Apply built-in Azure Policy definitions to Web PubSubhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/policy-definitions
Build serverless Web PubSub chat with client authenticationhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/quickstart-serverless
Authenticate with Web PubSub for Socket.IOhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/socketio-authentication
Add authentication and permissions to Azure Web PubSub appshttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/tutorial-permission
Authenticate and authorize MQTT clients for Azure Web PubSubhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/tutorial-upstream-auth-mqtt-client

Configuration

TopicURL
Configure storage and enable Azure Web PubSub Chathttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/chat-howto-enable-chat
Use metrics and alerts for Azure Web PubSubhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/concept-metrics
Configure monitoring for Azure Web PubSub with Azure Monitorhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-azure-monitor
Configure custom domains for Azure Web PubSubhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-custom-domain
Configure Azure Web PubSub event handlers and routinghttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-develop-eventhandler
Enable geo-replication for Azure Web PubSubhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-enable-geo-replication
Reference for Azure Web PubSub monitoring metrics and logshttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-monitor-data-reference
Use Azure Web PubSub local tunnel for developmenthttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-web-pubsub-tunnel-tool
CloudEvents extensions for Web PubSub MQTT handlershttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-mqtt-cloud-events
Write OData filter expressions for Web PubSubhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-odata-filter
Configure Azure Web PubSub Socket.IO serverless protocolhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/socket-io-serverless-protocol
Use Azure Socket.IO Admin UI for monitoringhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/socketio-troubleshoot-admin-ui

Integrations & Coding Patterns

TopicURL
Manage Azure Web PubSub chat rooms via SDK and RESThttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/chat-howto-manage-rooms
Send and manage messages in Azure Web PubSub chathttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/chat-howto-messages
Connect MQTT and WebSocket clients to Azure Web PubSubhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-connect-mqtt-websocket-client
Configure Azure Web PubSub client events to Event Hubshttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-develop-event-listener
Generate Azure Web PubSub client access URLshttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-generate-client-access-url
Implement upstream servers for Azure Web PubSub eventshttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-web-pubsub-write-upstream-server
Create WebSocket clientshttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-websocket-connect
Use C# client SDK for Azure Web PubSubhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-client-sdk-csharp
Use Java client SDK for Azure Web PubSubhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-client-sdk-java
Use JavaScript client SDK for Azure Web PubSubhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-client-sdk-javascript
Use Python client SDK for Azure Web PubSubhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-client-sdk-python
Follow Azure Web PubSub client specificationhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-client-specification
Handle Web PubSub events via HTTP CloudEventshttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-cloud-events
Handle Web PubSub events via AMQP CloudEventshttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-cloud-events-amqp
Use Web PubSub triggers and bindings in Azure Functionshttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-functions-bindings
Implement reliable JSON WebSocket subprotocol for Web PubSubhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-json-reliable-webpubsub-subprotocol
Use Azure Web PubSub JSON WebSocket subprotocolhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-json-webpubsub-subprotocol
Implement reliable protobuf WebSocket subprotocol for Web PubSubhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-protobuf-reliable-webpubsub-subprotocol
Use Azure Web PubSub protobuf WebSocket subprotocolhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-protobuf-webpubsub-subprotocol
Use Azure Web PubSub data plane REST APIshttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-rest-api-data-plane
REST API semantics for MQTT in Azure Web PubSubhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-rest-api-mqtt
Use .NET server SDK for Azure Web PubSubhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-server-sdk-csharp
Use Java server SDK for Azure Web PubSubhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-server-sdk-java
Use JavaScript server SDK for Azure Web PubSubhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-server-sdk-js
Use Python server SDK for Azure Web PubSubhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-server-sdk-python
Authenticate and connect to Azure Web PubSubhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/samples-authenticate-and-connect
Integrate Web PubSub for Socket.IO with API Managementhttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/socket-io-howto-integrate-apim
Use Socket.IO Azure Functions triggers and bindingshttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/socket-io-serverless-function-binding
Integrate Web PubSub for Socket.IO into existing appshttps://learn.microsoft.com/en-us/azure/azure-web-pubsub/socketio-quickstart

Deployment