mcpField
A
azure-service-connector

azure-service-connector

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

About azure-service-connector

azure-service-connector is a guidance skill for Azure Service Connector users, pairing local quick references with remote documentation on connections, authentication, integrations, limitations, and troubleshooting.

Key features

  1. 01Connection troubleshooting
  2. 02Permission and authentication setup
  3. 03IaC and CLI connection settings
  4. 04Database, storage, and service integrations
  5. 05Limitations and regional support

Use cases

  1. 01Diagnose service connection issues in Azure apps
  2. 02Set up managed identity or service principal authentication
  3. 03Connect databases, storage, or messaging services

Install

Copy the command and run it in a terminal.

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

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

Details

From the project README

Azure Service Connector Skill

This skill provides expert guidance for Azure Service Connector. Covers troubleshooting, 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
TroubleshootingL34-L40Diagnosing and resolving common Service Connector errors, connection failures, and AKS-specific integration issues, including error codes, logs, and step-by-step troubleshooting guidance.
Limits & QuotasL41-L45Known limitations of Azure Service Connector, unsupported scenarios, and suggested workarounds or alternatives for common connection and configuration issues.
SecurityL46-L51Managing Service Connector security: required permissions, Microsoft Entra role assignments, and configuring auth methods (managed identity, service principal, key-based).
ConfigurationL52-L60Configuring Service Connector connections via IaC/CLI, setting auth and environment variables, and specific setup for Azure Cache for Redis and retrieving connection configs.
Integrations & Coding PatternsL61-L92How to connect Azure compute to databases, messaging, storage, AI, and third‑party services using Service Connector, including setup patterns, auth options, and integration examples.
DeploymentL93-L96Info on where Service Connector is regionally supported per compute service and how to create connections using infrastructure-as-code tools.
Troubleshooting
TopicURL
Resolve common Azure Service Connector issueshttps://learn.microsoft.com/en-us/azure/service-connector/faq
Diagnose and fix Azure Service Connector errorshttps://learn.microsoft.com/en-us/azure/service-connector/how-to-troubleshoot-front-end-error
Use Service Connector with AKS and troubleshoot connectionshttps://learn.microsoft.com/en-us/azure/service-connector/how-to-use-service-connector-in-aks
Limits & Quotas
TopicURL
Service Connector known limitations and workaroundshttps://learn.microsoft.com/en-us/azure/service-connector/known-limitations
Security
TopicURL
Review Microsoft Entra roles assigned by Service Connectorhttps://learn.microsoft.com/en-us/azure/service-connector/concept-microsoft-entra-roles
Configure required permissions for Azure Service Connectorhttps://learn.microsoft.com/en-us/azure/service-connector/concept-permission
Configuration
TopicURL
Define Azure Service Connector IaC connection settingshttps://learn.microsoft.com/en-us/azure/service-connector/how-to-build-connections-with-iac-tools
Retrieve and use Service Connector connection configurationshttps://learn.microsoft.com/en-us/azure/service-connector/how-to-get-configurations
Configure Service Connector for Azure Cache for Redishttps://learn.microsoft.com/en-us/azure/service-connector/how-to-integrate-redis-cache
Configure authentication options and env vars in Service Connectorhttps://learn.microsoft.com/en-us/azure/service-connector/how-to-manage-authentication
Provide correct CLI parameters to Azure Service Connectorhttps://learn.microsoft.com/en-us/azure/service-connector/how-to-provide-correct-parameters
Integrations & Coding Patterns
TopicURL
Integrate Foundry Tools with Azure apps via Service Connectorhttps://learn.microsoft.com/en-us/azure/service-connector/how-to-integrate-ai-services
Integrate Azure App Configuration using Service Connectorhttps://learn.microsoft.com/en-us/azure/service-connector/how-to-integrate-app-configuration
Connect Azure AI Multi-Service Resource via Service Connectorhttps://learn.microsoft.com/en-us/azure/service-connector/how-to-integrate-cognitive-services
Connect Confluent Cloud Kafka with Azure via Service Connectorhttps://learn.microsoft.com/en-us/azure/service-connector/how-to-integrate-confluent-kafka
Connect Azure Cosmos DB for Cassandra with Service Connectorhttps://learn.microsoft.com/en-us/azure/service-connector/how-to-integrate-cosmos-cassandra
Integrate Azure Cosmos DB for MongoDB via Service Connectorhttps://learn.microsoft.com/en-us/azure/service-connector/how-to-integrate-cosmos-db
Connect Azure Cosmos DB for Gremlin with Service Connectorhttps://learn.microsoft.com/en-us/azure/service-connector/how-to-integrate-cosmos-gremlin
Connect Cosmos DB for NoSQL via Service Connectorhttps://learn.microsoft.com/en-us/azure/service-connector/how-to-integrate-cosmos-sql
Connect Cosmos DB for Table via Service Connectorhttps://learn.microsoft.com/en-us/azure/service-connector/how-to-integrate-cosmos-table
Configure Service Connector integration with Azure Event Hubshttps://learn.microsoft.com/en-us/azure/service-connector/how-to-integrate-event-hubs
Connect Fabric SQL databases via Service Connectorhttps://learn.microsoft.com/en-us/azure/service-connector/how-to-integrate-fabric-sql
Integrate Azure Key Vault with Service Connectorhttps://learn.microsoft.com/en-us/azure/service-connector/how-to-integrate-key-vault
Connect MongoDB Atlas clusters via Service Connectorhttps://learn.microsoft.com/en-us/azure/service-connector/how-to-integrate-mongodb-atlas
Integrate Azure Database for MySQL using Service Connectorhttps://learn.microsoft.com/en-us/azure/service-connector/how-to-integrate-mysql
Integrate Neon Serverless Postgres with Service Connectorhttps://learn.microsoft.com/en-us/azure/service-connector/how-to-integrate-neon-postgres
Integrate Azure OpenAI in Foundry Models via Service Connectorhttps://learn.microsoft.com/en-us/azure/service-connector/how-to-integrate-openai
Connect Azure Database for PostgreSQL via Service Connectorhttps://learn.microsoft.com/en-us/azure/service-connector/how-to-integrate-postgres
Connect Azure Service Bus using Service Connectorhttps://learn.microsoft.com/en-us/azure/service-connector/how-to-integrate-service-bus
Integrate Azure SignalR Service using Service Connectorhttps://learn.microsoft.com/en-us/azure/service-connector/how-to-integrate-signalr
Connect Azure SQL Database via Service Connectorhttps://learn.microsoft.com/en-us/azure/service-connector/how-to-integrate-sql-database
Connect to Azure Blob Storage via Service Connectorhttps://learn.microsoft.com/en-us/azure/service-connector/how-to-integrate-storage-blob
Connect Azure Files to compute with Service Connectorhttps://learn.microsoft.com/en-us/azure/service-connector/how-to-integrate-storage-file
Integrate Azure Queue Storage via Service Connectorhttps://learn.microsoft.com/en-us/azure/service-connector/how-to-integrate-storage-queue
Integrate Azure Table Storage with Service Connectorhttps://learn.microsoft.com/en-us/azure/service-connector/how-to-integrate-storage-table
Connect Azure Web PubSub using Service Connectorhttps://learn.microsoft.com/en-us/azure/service-connector/how-to-integrate-web-pubsub
Connect JBoss EAP on App Service to MySQL with managed identityhttps://learn.microsoft.com/en-us/azure/service-connector/tutorial-java-jboss-connect-managed-identity-mysql-database
Store Service Connector settings in Azure App Configurationhttps://learn.microsoft.com/en-us/azure/service-connector/tutorial-portal-app-configuration-store
Use Service Connector with AKS workload identity for Storagehttps://learn.microsoft.com/en-us/azure/service-connector/tutorial-python-aks-storage-workload-identity
Deployment
TopicURL
Check Service Connector regional support by compute servicehttps://learn.microsoft.com/en-us/azure/service-connector/concept-region-support

Comments

Markdown supported