azure-relay — Claude Code skill: use and install
This skill guides Azure Relay setup, error diagnosis, and Hybrid Connections work. It fits projects using .NET or Node.js relay clients.
CC-BY-4.0 162 installs ★ 818 updated 2026-10-25
npx skills add MicrosoftDocs/Agent-Skills --skill azure-relay -a claude-codeWhat azure-relay does
The skill covers Azure Relay troubleshooting, network settings, firewall rules, security, and integration patterns. Its references include Entra ID and SAS authentication, managed identities, IP firewall rules, virtual network rules, and Private Link Service.
It combines local quick-reference material with fetched documentation. The agent can retrieve pages through mcp_microsoftdocs:microsoft_docs_fetch, with fetch_webpage as a fallback. The covered coding paths include .NET Hybrid Connections APIs, Node.js WebSocket APIs, WCF relays, and the protocol for custom clients.
Network access is required for remote documentation retrieval. This skill is for Azure Relay; Azure Service Bus, Event Hubs, and Web PubSub use separate skills.
What it helps with
- diagnose an Azure Relay exception
- configure Entra ID or SAS authentication
- check relay ports and firewall rules
- set up Private Link Service security
- build a .NET or Node.js Hybrid Connections client
Example prompts for the agent
- Investigate this Azure Relay connection error and check the network configuration.
- Set up Entra ID, managed identity, and firewall rules for this relay.
- Show how to build a Node.js Hybrid Connections client with the WebSocket API.
How to install azure-relay
1Skills CLI (Vercel)
npx skills add MicrosoftDocs/Agent-Skills --skill azure-relay -a claude-code2Manually: put the files in place
~/.claude/skills/azure-relay/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/azure-relay/
1Skills CLI (Vercel)
npx skills add MicrosoftDocs/Agent-Skills --skill azure-relay -a codex2Manually: put the files in place
.agents/skills/azure-relay/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add MicrosoftDocs/Agent-Skills --skill azure-relay -a cursor2Manually: put the files in place
.cursor/skills/azure-relay/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install MicrosoftDocs/Agent-Skills skills/azure-relay2Manually: put the files in place
.github/skills/azure-relay/SKILL.md1Skills CLI (Vercel)
npx skills add MicrosoftDocs/Agent-Skills --skill azure-relay -a gemini-cli2Platform CLI
gemini skills install https://github.com/MicrosoftDocs/Agent-Skills --path skills/azure-relayManually: put the files in place
.devin/skills/azure-relay/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add MicrosoftDocs/Agent-Skills --skill azure-relay -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about azure-relay
How do I install azure-relay in Claude Code?
Run npx skills add MicrosoftDocs/Agent-Skills --skill azure-relay -a claude-code, then check ~/.claude/skills/azure-relay/SKILL.md.
What does azure-relay do?
It provides guidance for Azure Relay configuration, security, troubleshooting, and integrations. The material covers Hybrid Connections, WCF relays, and .NET and Node.js clients.
Does azure-relay need network access?
Yes. Remote documentation is fetched through mcp_microsoftdocs:microsoft_docs_fetch, or through fetch_webpage when that tool is unavailable.
Source text
SKILL.md · CC-BY-4.0
--- name: azure-relay description: Expert knowledge for Azure Relay development including troubleshooting, security, configuration, and integrations & coding patterns. Use when configuring Hybrid Connections, WCF relays, Entra ID/SAS auth, Private Link, or .NET/Node.js Relay clients, and other Azure Relay related development tasks. Not for Azure Service Bus (use azure-service-bus), Azure Event Hubs (use azure-event-hubs), Azure Web PubSub (use azure-web-pubsub), Azure Application Gateway (use azure-application-gateway). compatibility: Requires network access. Uses mcp_microsoftdocs:microsoft_docs_fetch or fetch_webpage to retrieve documentation. metadata: generated_at: "2026-05-17" generator: "docs2skills/1.0.0" --- # Azure Relay Skill This skill provides expert guidance for Azure Relay. Covers troubleshooting, security, configuration, and integrations & coding patterns. 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](https://github.com/MicrosoftDocs/mcp/blob/main/README.md) 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 | Category | Lines | Description | |----------|-------|-------------| | Troubleshooting | L32-L36 | Diagnosing and fixing common Azure Relay exceptions, including connection, authentication, quota, and configuration errors, with guidance on causes and resolutions. | | Security | L37-L46 | Authentication and network security for Azure Relay: Entra ID and SAS auth, managed identities, IP firewall, virtual network rules, and Private Link Service configuration. | | Configuration | L47-L51 | Network and firewall requirements for Azure Relay, including which ports/protocols to open for Hybrid Connections and WCF relays and how to configure them. | | Integrations & Coding Patterns | L52-L57 | Using Azure Relay Hybrid Connections from .NET and Node.js (WebSockets), plus low-level protocol details for implementing custom clients and integrations | ### Troubleshooting | Topic | URL | |-------|-----| | Resolve common Azure Relay exceptions | https://learn.microsoft.com/en-us/azure/azure-relay/relay-exceptions | ### Security | Topic | URL | |-------|-----| | Authenticate applications to Azure Relay with Entra ID | https://learn.microsoft.com/en-us/azure/azure-relay/authenticate-application | | Use managed identities to access Azure Relay | https://learn.microsoft.com/en-us/azure/azure-relay/authenticate-managed-identity | | Configure IP firewall rules for Azure Relay | https://learn.microsoft.com/en-us/azure/azure-relay/ip-firewall-virtual-networks | | Configure network security for Azure Relay | https://learn.microsoft.com/en-us/azure/azure-relay/network-security | | Secure Azure Relay with Private Link Service | https://learn.microsoft.com/en-us/azure/azure-relay/private-link-service | | Configure SAS and Entra ID auth for Azure Relay | https://learn.microsoft.com/en-us/azure/azure-relay/relay-authentication-and-authorization | ### Configuration | Topic | URL | |-------|-----| | Configure required port settings for Azure Relay | https://learn.microsoft.com/en-us/azure/azure-relay/relay-port-settings | ### Integrations & Coding Patterns | Topic | URL | |-------|-----| | Use Azure Relay Hybrid Connections .NET APIs | https://learn.microsoft.com/en-us/azure/azure-relay/relay-hybrid-connections-dotnet-api-overview | | Use Azure Relay Node.js WebSocket APIs | https://learn.microsoft.com/en-us/azure/azure-relay/relay-hybrid-connections-node-ws-api-overview | | Implement Azure Relay Hybrid Connections protocol | https://learn.microsoft.com/en-us/azure/azure-relay/relay-hybrid-connections-protocol |
© MicrosoftDocs · CC-BY-4.0 · MicrosoftDocs/Agent-Skills