azure-signalr-service

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Azure SignalR Service Skill

Azure SignalR Service 技能指南

This skill provides expert guidance for Azure SignalR Service. 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 SignalR Service提供专业指导，涵盖故障排查、最佳实践、决策制定、架构与设计模式、限制与配额、安全防护、配置、集成与编码模式，以及部署相关内容。它结合了本地快速参考内容与远程文档获取能力。

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.

Agent 重要提示：请使用下方的分类索引定位相关章节。对于带有行号范围的分类（例如
L35-L120
），请使用
read_file
工具读取指定行内容。对于带有文件链接的分类（例如
[security.md](security.md)
），请使用
read_file
工具读取链接的参考文件。

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格式内容。

Category Index

分类索引

Category	Lines	Description
Troubleshooting	L37-L45	Diagnosing and fixing SignalR issues using logs and live trace, covering connectivity, message delivery, common errors, and FAQ-style troubleshooting tips.
Best Practices	L46-L51	Guidance on safely shutting down SignalR app servers and managing client lifecycle events, including detecting, handling, and recovering from client disconnects and reconnects.
Decision Making	L52-L57	Guidance on choosing the right SignalR Service mode (Default/Serverless/Classic) and configuring availability zones/zone redundancy for high availability and resilience.
Architecture & Design Patterns	L58-L64	Patterns for scaling and sharding Azure SignalR, designing multi-instance topologies, and building resilient, disaster-ready SignalR deployments for ASP.NET Core apps
Limits & Quotas	L65-L71	Message/connection billing rules, capacity planning, throughput limits, and how to scale Azure SignalR instances within quota and performance constraints.
Security	L72-L93	Securing Azure SignalR: auth with Entra ID/managed identities, keys and rotation, network/private endpoints/NSGs, WAF, Key Vault, RBAC, cross-tenant access, and Azure Policy compliance.
Configuration	L94-L105	Configuring SignalR apps: connection strings, upstream endpoints, custom domains, monitoring/metrics, negotiation endpoints, Functions bindings, and using the local emulator.
Integrations & Coding Patterns	L106-L120	Using SignalR from servers and REST, managing clients, integrating with Event Grid, API Management, Application Gateway, and detailed data-plane REST API references
Deployment	L121-L131	Deploying and managing Azure SignalR via CLI, ARM/Bicep templates, autoscale setup, regional moves, and end-to-end web app deployment (incl. GitHub auth)

分类	行号	描述
故障排查	L37-L45	使用日志和实时跟踪诊断并修复SignalR问题，涵盖连接性、消息传递、常见错误及FAQ式故障排查技巧。
最佳实践	L46-L51	指导如何安全关闭SignalR应用服务器及管理客户端生命周期事件，包括检测、处理和恢复客户端断开与重连的情况。
决策制定	L52-L57	指导如何选择合适的SignalR Service模式（默认/无服务器/经典），以及配置可用区/区域冗余以实现高可用性和弹性。
架构与设计模式	L58-L64	Azure SignalR的扩展与分片模式、多实例拓扑设计，以及为ASP.NET Core应用构建具备弹性、容灾能力的SignalR部署方案。
限制与配额	L65-L71	消息/连接计费规则、容量规划、吞吐量限制，以及如何在配额和性能约束内扩展Azure SignalR实例。
安全防护	L72-L93	Azure SignalR的安全配置：使用Entra ID/托管身份进行认证、密钥与密钥轮换、网络/专用端点/NSG、WAF、Key Vault、RBAC、跨租户访问及Azure Policy合规性。
配置	L94-L105	SignalR应用配置：连接字符串、上游端点、自定义域名、监控/指标、协商端点、Functions绑定，以及使用本地模拟器。
集成与编码模式	L106-L120	从服务器和REST使用SignalR、管理客户端、与Event Grid、API Management、Application Gateway集成，以及详细的数据平面REST API参考。
部署	L121-L131	通过CLI、ARM/Bicep模板部署和管理Azure SignalR、自动扩展设置、跨区域迁移，以及端到端Web应用部署（含GitHub认证）。

Troubleshooting

故障排查

Topic	URL
Use Azure Monitor resource logs to troubleshoot SignalR	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-diagnostic-logs
Troubleshoot common Azure SignalR Service issues	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-troubleshoot-guide
Use the Azure SignalR live trace tool for diagnostics	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-troubleshoot-live-trace
Troubleshoot SignalR connectivity and message delivery	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-troubleshoot-method
Azure SignalR Service FAQ and troubleshooting tips	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-resource-faq

主题	URL
使用Azure Monitor资源日志排查SignalR问题	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-diagnostic-logs
排查Azure SignalR Service常见问题	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-troubleshoot-guide
使用Azure SignalR实时跟踪工具进行诊断	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-troubleshoot-live-trace
排查SignalR连接性和消息传递问题	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-troubleshoot-method
Azure SignalR Service常见问题与故障排查技巧	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-resource-faq

Best Practices

最佳实践

Topic	URL
Gracefully shut down Azure SignalR app servers	https://learn.microsoft.com/en-us/azure/azure-signalr/server-graceful-shutdown
Handle client disconnections and reconnections in Azure SignalR	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-concept-client-disconnections

主题	URL
优雅关闭Azure SignalR应用服务器	https://learn.microsoft.com/en-us/azure/azure-signalr/server-graceful-shutdown
处理Azure SignalR中的客户端断开与重连	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-concept-client-disconnections

Decision Making

决策制定

Topic	URL
Use availability zones and zone redundancy for Azure SignalR	https://learn.microsoft.com/en-us/azure/azure-signalr/availability-zones
Choose the right Azure SignalR Service mode	https://learn.microsoft.com/en-us/azure/azure-signalr/concept-service-mode

主题	URL
为Azure SignalR使用可用区和区域冗余	https://learn.microsoft.com/en-us/azure/azure-signalr/availability-zones
选择合适的Azure SignalR Service模式	https://learn.microsoft.com/en-us/azure/azure-signalr/concept-service-mode

Architecture & Design Patterns

架构与设计模式

Topic	URL
Design resilient and disaster-ready Azure SignalR deployments	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-concept-disaster-recovery
Scale ASP.NET Core SignalR apps using Azure SignalR	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-concept-scale-aspnet-core
Scale Azure SignalR with multiple instances and sharding	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-scale-multi-instances

主题	URL
设计具备弹性和容灾能力的Azure SignalR部署方案	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-concept-disaster-recovery
使用Azure SignalR扩展ASP.NET Core SignalR应用	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-concept-scale-aspnet-core
通过多实例和分片扩展Azure SignalR	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-scale-multi-instances

Limits & Quotas

限制与配额

Topic	URL
Understand message and connection counting for SignalR billing	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-concept-messages-and-connections
Plan Azure SignalR performance and capacity	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-concept-performance
Scale Azure SignalR instances and understand scaling constraints	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-scale-signalr

主题	URL
理解SignalR计费的消息和连接计数规则	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-concept-messages-and-connections
规划Azure SignalR的性能和容量	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-concept-performance
扩展Azure SignalR实例并理解扩展约束	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-scale-signalr

Security

安全防护

Topic	URL
Disable access key auth and enforce Entra ID for SignalR	https://learn.microsoft.com/en-us/azure/azure-signalr/howto-disable-local-auth
Configure network access control for Azure SignalR	https://learn.microsoft.com/en-us/azure/azure-signalr/howto-network-access-control
Secure Azure SignalR with private endpoints	https://learn.microsoft.com/en-us/azure/azure-signalr/howto-private-endpoints
Use Azure SignalR service tags in NSGs	https://learn.microsoft.com/en-us/azure/azure-signalr/howto-service-tags
Secure SignalR outbound traffic via shared private endpoints	https://learn.microsoft.com/en-us/azure/azure-signalr/howto-shared-private-endpoints
Access Key Vault privately from Azure SignalR	https://learn.microsoft.com/en-us/azure/azure-signalr/howto-shared-private-endpoints-key-vault
Use managed identities with Azure SignalR Service	https://learn.microsoft.com/en-us/azure/azure-signalr/howto-use-managed-identity
Built-in Azure Policy definitions for Azure SignalR	https://learn.microsoft.com/en-us/azure/azure-signalr/policy-reference
Apply Azure Policy regulatory compliance controls to SignalR	https://learn.microsoft.com/en-us/azure/azure-signalr/security-controls-policy
Implement custom authentication for Azure SignalR clients	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-concept-authenticate-oauth
Authorize Azure SignalR access with Microsoft Entra ID RBAC	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-concept-authorize-azure-active-directory
Authorize Azure SignalR with Microsoft Entra applications	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-authorize-application
Configure cross-tenant authorization for Azure SignalR	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-authorize-cross-tenant
Authorize Azure SignalR with managed identities	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-authorize-managed-identity
Enforce Azure SignalR compliance with Azure Policy	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-azure-policy
Configure Azure SignalR Application Firewall rules	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-configure-application-firewall
Rotate Azure SignalR access keys securely	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-key-rotation
Authenticate Azure SignalR clients with Azure Functions bindings	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-tutorial-authenticate-azure-functions

主题	URL
禁用访问密钥认证并强制对SignalR使用Entra ID	https://learn.microsoft.com/en-us/azure/azure-signalr/howto-disable-local-auth
配置Azure SignalR的网络访问控制	https://learn.microsoft.com/en-us/azure/azure-signalr/howto-network-access-control
使用专用端点保护Azure SignalR	https://learn.microsoft.com/en-us/azure/azure-signalr/howto-private-endpoints
在NSG中使用Azure SignalR服务标签	https://learn.microsoft.com/en-us/azure/azure-signalr/howto-service-tags
通过共享专用端点保护SignalR出站流量	https://learn.microsoft.com/en-us/azure/azure-signalr/howto-shared-private-endpoints
从Azure SignalR私有访问Key Vault	https://learn.microsoft.com/en-us/azure/azure-signalr/howto-shared-private-endpoints-key-vault
在Azure SignalR Service中使用托管身份	https://learn.microsoft.com/en-us/azure/azure-signalr/howto-use-managed-identity
Azure SignalR的内置Azure Policy定义	https://learn.microsoft.com/en-us/azure/azure-signalr/policy-reference
对SignalR应用Azure Policy合规性控制	https://learn.microsoft.com/en-us/azure/azure-signalr/security-controls-policy
为Azure SignalR客户端实现自定义认证	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-concept-authenticate-oauth
使用Microsoft Entra ID RBAC授权Azure SignalR访问	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-concept-authorize-azure-active-directory
使用Microsoft Entra应用授权Azure SignalR	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-authorize-application
配置Azure SignalR的跨租户授权	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-authorize-cross-tenant
使用托管身份授权Azure SignalR	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-authorize-managed-identity
用Azure Policy强制Azure SignalR合规性	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-azure-policy
配置Azure SignalR应用防火墙规则	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-configure-application-firewall
安全轮换Azure SignalR访问密钥	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-key-rotation
使用Azure Functions绑定认证Azure SignalR客户端	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-tutorial-authenticate-azure-functions

Configuration

配置

Topic	URL
Configure Azure SignalR Service connection strings in apps	https://learn.microsoft.com/en-us/azure/azure-signalr/concept-connection-string
Configure upstream endpoints and protocols in Azure SignalR	https://learn.microsoft.com/en-us/azure/azure-signalr/concept-upstream
Configure custom domains for Azure SignalR Service	https://learn.microsoft.com/en-us/azure/azure-signalr/howto-custom-domain
Configure monitoring for Azure SignalR with Azure Monitor	https://learn.microsoft.com/en-us/azure/azure-signalr/monitor-signalr
Reference for Azure SignalR monitoring metrics and logs	https://learn.microsoft.com/en-us/azure/azure-signalr/monitor-signalr-reference
Customize client negotiation endpoints in Azure SignalR	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-concept-client-negotiation
Develop and configure Azure Functions apps with SignalR bindings	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-concept-serverless-development-config
Use Azure SignalR Local Emulator for serverless development	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-emulator

主题	URL
在应用中配置Azure SignalR Service连接字符串	https://learn.microsoft.com/en-us/azure/azure-signalr/concept-connection-string
配置Azure SignalR的上游端点和协议	https://learn.microsoft.com/en-us/azure/azure-signalr/concept-upstream
为Azure SignalR Service配置自定义域名	https://learn.microsoft.com/en-us/azure/azure-signalr/howto-custom-domain
使用Azure Monitor配置Azure SignalR监控	https://learn.microsoft.com/en-us/azure/azure-signalr/monitor-signalr
Azure SignalR监控指标与日志参考	https://learn.microsoft.com/en-us/azure/azure-signalr/monitor-signalr-reference
自定义Azure SignalR中的客户端协商端点	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-concept-client-negotiation
使用SignalR绑定开发和配置Azure Functions应用	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-concept-serverless-development-config
使用Azure SignalR本地模拟器进行无服务器开发	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-emulator

Integrations & Coding Patterns

集成与编码模式

Topic	URL
Integrate Azure SignalR Service events with Event Grid	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-concept-event-grid-integration
Integrate Azure SignalR events with Event Grid	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-event-grid-integration
Use Azure SignalR Service SDK from your app server	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-use
Manage Azure SignalR clients using the Management SDK	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-use-management-sdk
Use Azure SignalR with API Management	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-work-with-apim
Use Azure SignalR with Application Gateway	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-work-with-app-gateway
Use Azure SignalR Service REST API for broadcasting	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-quickstart-rest-api
Use Azure SignalR data-plane REST APIs for messaging	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-reference-data-plane-rest-api
Azure SignalR data-plane REST API reference v1	https://learn.microsoft.com/en-us/azure/azure-signalr/swagger/signalr-data-plane-rest-v1
Azure SignalR data-plane REST API reference v1-preview	https://learn.microsoft.com/en-us/azure/azure-signalr/swagger/signalr-data-plane-rest-v1-preview
Azure SignalR data-plane REST API reference v20220601	https://learn.microsoft.com/en-us/azure/azure-signalr/swagger/signalr-data-plane-rest-v20220601

主题	URL
将Azure SignalR Service事件与Event Grid集成	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-concept-event-grid-integration
将Azure SignalR事件与Event Grid集成	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-event-grid-integration
在应用服务器中使用Azure SignalR Service SDK	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-use
使用管理SDK管理Azure SignalR客户端	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-use-management-sdk
将Azure SignalR与API Management集成	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-work-with-apim
将Azure SignalR与Application Gateway集成	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-work-with-app-gateway
使用Azure SignalR Service REST API进行广播	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-quickstart-rest-api
使用Azure SignalR数据平面REST API进行消息传递	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-reference-data-plane-rest-api
Azure SignalR数据平面REST API参考v1	https://learn.microsoft.com/en-us/azure/azure-signalr/swagger/signalr-data-plane-rest-v1
Azure SignalR数据平面REST API参考v1-preview	https://learn.microsoft.com/en-us/azure/azure-signalr/swagger/signalr-data-plane-rest-v1-preview
Azure SignalR数据平面REST API参考v20220601	https://learn.microsoft.com/en-us/azure/azure-signalr/swagger/signalr-data-plane-rest-v20220601

Deployment

部署

Topic	URL
Create an Azure SignalR Service via Azure CLI script	https://learn.microsoft.com/en-us/azure/azure-signalr/scripts/signalr-cli-create-service
Provision SignalR Service with App Service using Azure CLI	https://learn.microsoft.com/en-us/azure/azure-signalr/scripts/signalr-cli-create-with-app-service
Deploy SignalR web app with GitHub authentication via CLI	https://learn.microsoft.com/en-us/azure/azure-signalr/scripts/signalr-cli-create-with-app-service-github-oauth
Move Azure SignalR resources across regions with ARM templates	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-move-across-regions
Configure autoscale for Azure SignalR Premium tier	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-scale-autoscale
Deploy Azure SignalR Service using ARM templates	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-quickstart-azure-signalr-service-arm-template
Deploy Azure SignalR Service using Bicep templates	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-quickstart-azure-signalr-service-bicep
Azure CLI script samples for deploying SignalR Service	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-reference-cli

主题	URL
通过Azure CLI脚本创建Azure SignalR Service	https://learn.microsoft.com/en-us/azure/azure-signalr/scripts/signalr-cli-create-service
使用Azure CLI为App Service配置SignalR Service	https://learn.microsoft.com/en-us/azure/azure-signalr/scripts/signalr-cli-create-with-app-service
通过CLI部署带GitHub认证的SignalR Web应用	https://learn.microsoft.com/en-us/azure/azure-signalr/scripts/signalr-cli-create-with-app-service-github-oauth
使用ARM模板跨区域迁移Azure SignalR资源	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-move-across-regions
为Azure SignalR高级层配置自动扩展	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-scale-autoscale
使用ARM模板部署Azure SignalR Service	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-quickstart-azure-signalr-service-arm-template
使用Bicep模板部署Azure SignalR Service	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-quickstart-azure-signalr-service-bicep
Azure SignalR Service部署的CLI脚本示例	https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-reference-cli