azure-data-api-builder
Expert knowledge for Azure Data Api Builder development including troubleshooting, best practices, decision making, limits & quotas, security, configuration, integrations & coding patterns, and deployment. Use when building, debugging, or optimizing Azure Data Api Builder applications. Not for Azure API Management (use azure-api-management), Azure Functions (use azure-functions), Azure App Service (use azure-app-service), Azure Logic Apps (use azure-logic-apps).
From azurenpx claudepluginhub atc-net/atc-agentic-toolkitThis skill uses the workspace's default tool permissions.
Azure Data Api Builder Skill
This skill provides expert guidance for Azure Data Api Builder. Covers troubleshooting, best practices, decision making, 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: This file may be large. Use the Category Index below to locate relevant sections, then use
read_filewith specific line ranges (e.g.,L136-L144) to read the sections needed for the user's question This skill requires network access to fetch documentation content. Usemcp_microsoftdocs:microsoft_docs_fetchto retrieve full articles.
- Fallback: Use the built-in
WebFetchtool if the Microsoft Learn MCP server is not available.
Category Index
| Category | Lines | Description |
|---|---|---|
| Troubleshooting | L36-L40 | FAQ-style fixes for common Data API builder problems: config and connection errors, auth/authorization issues, deployment/runtime failures, and tips to diagnose and resolve them. |
| Best Practices | L41-L47 | Configuring DAB for reliability and performance, securing and connecting it to data sources, and adding semantic metadata to SQL MCP entities for AI consumption. |
| Decision Making | L48-L52 | Guidance on selecting Azure hosting options for Data API builder, comparing services (e.g., App Service, Functions, Container Apps) and trade-offs like cost, scalability, and management. |
| Limits & Quotas | L53-L58 | Configuring and enforcing page size limits for GraphQL and REST queries in Data API builder using the first/$first parameters. |
| Security | L59-L70 | Configuring auth and authorization in DAB: roles/permissions, EasyAuth, custom JWT and Entra ID, simulator auth, row-level security policies, and SQL MCP Server/database authentication. |
| Configuration | L71-L123 | Configuring DAB: CLI-based config management, entities and relationships, data sources (incl. Cosmos DB), caching, secrets, env-specific configs, monitoring, logging, and full schema reference. |
| Integrations & Coding Patterns | L124-L134 | Patterns for using DAB REST/GraphQL: upserts with If-Match, Location headers, $filter and select/projection, GraphQL filters, and SQL MCP DML tools for CRUD integration. |
| Deployment | L135-L149 | Deploying and running Data API builder and SQL MCP Server on Azure (Container Apps/Instances, Cosmos DB, Azure SQL, AZD/CLI), plus platform support, local dev, and Azure AI Foundry integration. |
Troubleshooting
| Topic | URL |
|---|---|
| Resolve common issues with Data API builder (FAQ) | https://learn.microsoft.com/en-us/azure/data-api-builder/faq |
Best Practices
| Topic | URL |
|---|---|
| Apply configuration best practices for Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/deployment/best-practices-configuration |
| Apply security and connectivity best practices for DAB | https://learn.microsoft.com/en-us/azure/data-api-builder/deployment/best-practices-security |
| Add semantic descriptions to SQL MCP entities for AI | https://learn.microsoft.com/en-us/azure/data-api-builder/mcp/how-to-add-descriptions |
Decision Making
| Topic | URL |
|---|---|
| Choose Azure hosting options for Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/deployment/hosting-options |
Limits & Quotas
| Topic | URL |
|---|---|
| Control GraphQL page size with first in DAB | https://learn.microsoft.com/en-us/azure/data-api-builder/keywords/first-graphql |
| Limit REST page size with $first in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/keywords/first-rest |
Security
Configuration
Integrations & Coding Patterns
| Topic | URL |
|---|---|
| Control upsert behavior with If-Match in DAB REST | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/api/http-if-match |
| Use Location header for created resources in DAB | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/api/http-location |
| Use GraphQL filter argument in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/keywords/filter-graphql |
| Use $filter in REST queries for Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/keywords/filter-rest |
| Shape REST and GraphQL payloads with select | https://learn.microsoft.com/en-us/azure/data-api-builder/keywords/select-graphql |
| Project REST responses with $select in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/keywords/select-rest |
| Use SQL MCP Server DML tools for CRUD operations | https://learn.microsoft.com/en-us/azure/data-api-builder/mcp/data-manipulation-language-tools |