mcpField
A
azure-relay

azure-relay

github.com/microsoftdocsCloud & DevOps796160 installsUpdated 3d ago
Repository

About azure-relay

A guidance skill for agents using Azure Relay, with material on troubleshooting, security, network configuration, and integrations. It pairs a local topic index with remote documentation retrieval.

Key features

  1. 01Common exception diagnosis
  2. 02Entra ID and SAS authentication guidance
  3. 03Network security and firewall settings
  4. 04Port and protocol configuration
  5. 05.NET and Node.js integration patterns
  6. 06Hybrid Connections protocol reference

Use cases

  1. 01Investigate connection, authentication, or quota errors
  2. 02Configure IP firewalls and virtual network rules
  3. 03Determine required Relay ports and protocols
  4. 04Implement Hybrid Connections with .NET or Node.js

MCP support

It can fetch Microsoft documentation through mcp_microsoftdocs:microsoft_docs_fetch, with fetch_webpage as a fallback.

Install

Copy the command and run it in a terminal.

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

After installing, type/azure-relayin Claude Code to confirm it loaded.

Details

From the project README

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

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
TroubleshootingL32-L36Diagnosing and fixing common Azure Relay exceptions, including connection, authentication, quota, and configuration errors, with guidance on causes and resolutions.
SecurityL37-L46Authentication and network security for Azure Relay: Entra ID and SAS auth, managed identities, IP firewall, virtual network rules, and Private Link Service configuration.
ConfigurationL47-L51Network 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 PatternsL52-L57Using Azure Relay Hybrid Connections from .NET and Node.js (WebSockets), plus low-level protocol details for implementing custom clients and integrations
Troubleshooting
TopicURL
Resolve common Azure Relay exceptionshttps://learn.microsoft.com/en-us/azure/azure-relay/relay-exceptions
Security
TopicURL
Authenticate applications to Azure Relay with Entra IDhttps://learn.microsoft.com/en-us/azure/azure-relay/authenticate-application
Use managed identities to access Azure Relayhttps://learn.microsoft.com/en-us/azure/azure-relay/authenticate-managed-identity
Configure IP firewall rules for Azure Relayhttps://learn.microsoft.com/en-us/azure/azure-relay/ip-firewall-virtual-networks
Configure network security for Azure Relayhttps://learn.microsoft.com/en-us/azure/azure-relay/network-security
Secure Azure Relay with Private Link Servicehttps://learn.microsoft.com/en-us/azure/azure-relay/private-link-service
Configure SAS and Entra ID auth for Azure Relayhttps://learn.microsoft.com/en-us/azure/azure-relay/relay-authentication-and-authorization
Configuration
TopicURL
Configure required port settings for Azure Relayhttps://learn.microsoft.com/en-us/azure/azure-relay/relay-port-settings
Integrations & Coding Patterns
TopicURL
Use Azure Relay Hybrid Connections .NET APIshttps://learn.microsoft.com/en-us/azure/azure-relay/relay-hybrid-connections-dotnet-api-overview
Use Azure Relay Node.js WebSocket APIshttps://learn.microsoft.com/en-us/azure/azure-relay/relay-hybrid-connections-node-ws-api-overview
Implement Azure Relay Hybrid Connections protocolhttps://learn.microsoft.com/en-us/azure/azure-relay/relay-hybrid-connections-protocol

Comments

Markdown supported