1---2name: azure-data-api-builder3description: 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 defining DAB entities, securing Entra ID/JWT access, exposing REST/GraphQL, or deploying on Azure, and other Azure Data Api Builder related development tasks. Not for Azure App Service (use azure-app-service), Azure Functions (use azure-functions), Azure API Management (use azure-api-management), Azure SQL Database (use azure-sql-database). Use when this capability is needed.4---5# Azure Data API Builder Skill67This 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.89## How to Use This Skill1011> **IMPORTANT for Agent**: This file may be large. Use the **Category Index** below to locate relevant sections, then use `read_file` with specific line ranges (e.g., `L136-L144`) to read the sections needed for the user's question12This skill requires **network access** to fetch documentation content.13Use `mcp_microsoftdocs:microsoft_docs_fetch` to retrieve full articles.14- **Fallback**: Use the built-in `WebFetch` tool if the Microsoft Learn MCP server is not available.1516## Category Index1718| Category | Lines | Description |19|----------|-------|-------------|20| Troubleshooting | L30-L33 | 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. |21| Best Practices | L35-L40 | Configuring DAB for reliability and performance, securing and connecting it to data sources, and adding semantic metadata to SQL MCP entities for AI consumption. |22| Decision Making | L42-L45 | 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. |23| Limits & Quotas | L47-L52 | Configuring SQL command timeouts and controlling response sizes in Data API builder using GraphQL `first` and REST `$first` pagination limits. |24| Security | L54-L64 | Configuring authentication/authorization for DAB: roles/permissions, Entra ID, EasyAuth, custom JWT, simulator auth, SQL row-level security, and SQL MCP Server auth. |25| Configuration | L66-L117 | Configuring DAB: CLI-based config management, entities and data sources, caching, secrets/env configs, OpenAPI/GraphQL, logging/telemetry, health, and provider-specific settings. |26| Integrations & Coding Patterns | L119-L130 | Using DAB from code/CLI: exporting GraphQL schemas, starting the runtime, shaping/filtering REST/GraphQL responses, controlling upserts and Location headers, and SQL MCP tools for AI agents. |27| Deployment | L132-L140 | 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. |2829### Troubleshooting30| Topic | URL |31|-------|-----|32| Resolve common issues with Data API builder (FAQ) | https://learn.microsoft.com/en-us/azure/data-api-builder/faq |3334### Best Practices35| Topic | URL |36|-------|-----|37| Apply configuration best practices for Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/deployment/best-practices-configuration |38| Apply security and connectivity best practices for DAB | https://learn.microsoft.com/en-us/azure/data-api-builder/deployment/best-practices-security |39| Add semantic descriptions to SQL MCP entities for AI | https://learn.microsoft.com/en-us/azure/data-api-builder/mcp/how-to-add-descriptions |4041### Decision Making42| Topic | URL |43|-------|-----|44| Choose Azure hosting options for Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/deployment/hosting-options |4546### Limits & Quotas47| Topic | URL |48|-------|-----|49| Configure SQL Server command timeout in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/how-to/configure-timeout |50| Control GraphQL page size with first in DAB | https://learn.microsoft.com/en-us/azure/data-api-builder/keywords/first-graphql |51| Limit REST page size with $first in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/keywords/first-rest |5253### Security54| Topic | URL |55|-------|-----|56| Configure roles and permissions for authorization in DAB | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/authorization |57| Use Azure App Service EasyAuth with Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/how-to-authenticate-app-service |58| Configure custom JWT authentication providers in DAB | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/how-to-authenticate-custom |59| Configure Microsoft Entra ID authentication for Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/how-to-authenticate-entra |60| Use Simulator authentication for local DAB permission testing | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/how-to-authenticate-simulator |61| Configure database policies for row-level filtering in DAB | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/how-to-configure-database-policies |62| Implement SQL row-level security with DAB session context | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/row-level-security |63| Configure authentication for SQL MCP Server and database | https://learn.microsoft.com/en-us/azure/data-api-builder/mcp/how-to-configure-authentication |6465### Configuration66| Topic | URL |67|-------|-----|68| Use Data API builder CLI commands to manage configs | https://learn.microsoft.com/en-us/azure/data-api-builder/command-line/ |69| Add entities to Data API builder configuration with CLI | https://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-add |70| Configure Data API builder runtime and data source via CLI | https://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-configure |71| Initialize Data API builder configuration files with CLI | https://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-init |72| Update Data API builder entity definitions with CLI | https://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-update |73| Validate Data API builder configuration files in CI/CD | https://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-validate |74| Configure OpenAPI and Swagger for DAB REST APIs | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/api/openapi |75| Control Data API builder caching via HTTP headers | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/cache/http-headers |76| Configure internal level 1 cache in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/cache/level-1 |77| Configure external Redis level 2 cache in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/cache/level-2 |78| Load secrets from Azure Key Vault with @akv in DAB | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/config/akv-function |79| Reference environment variables with @env in DAB config | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/config/env-function |80| Use environment-specific config files in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/config/environments |81| Configure multiple data sources and hybrid endpoints in DAB | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/config/multi-data-source |82| Configure entity relationships for GraphQL in DAB | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/database/relationships |83| Expose stored procedures as endpoints in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/database/stored-procedures |84| Expose database views as DAB REST/GraphQL endpoints | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/database/views |85| Configure Azure Application Insights monitoring for DAB | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/monitor/application-insights |86| Configure and use the /health endpoint in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/monitor/health-checks |87| Configure Azure Log Analytics integration for DAB | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/monitor/log-analytics |88| Set filtered log levels in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/monitor/log-levels |89| Enable OpenTelemetry tracing and metrics in DAB | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/monitor/open-telemetry |90| Full configuration schema for Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/ |91| Reference schema for Data API builder configuration file | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/ |92| Configure Data API builder data source section | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/data-source |93| Configure entities section in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities |94| Configure entities section in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities |95| Configure entities section in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities |96| Configure entities section in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities |97| Configure entities section in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities |98| Configure entities section in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities |99| Configure entities section in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities |100| Configure entities section in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities |101| Configure entities section in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities |102| Configure entities section in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities |103| Configure entities section in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities |104| Configure entities section in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities |105| Configure runtime settings for Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/runtime |106| Configure runtime settings for Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/runtime |107| Configure runtime settings for Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/runtime |108| Configure runtime settings for Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/runtime |109| Configure Data API builder runtime behavior | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/runtime |110| Configure Data API builder runtime behavior | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/runtime |111| Configure runtime settings for Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/runtime |112| Configure runtime settings for Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/runtime |113| Configure Data API builder runtime behavior | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/runtime |114| Configure Data API builder runtime behavior | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/runtime |115| Configure DAB for Azure Cosmos DB for NoSQL | https://learn.microsoft.com/en-us/azure/data-api-builder/how-to/set-up-cosmosdb |116| Configure stdio transport mode for SQL MCP Server | https://learn.microsoft.com/en-us/azure/data-api-builder/mcp/stdio-transport |117118### Integrations & Coding Patterns119| Topic | URL |120|-------|-----|121| Export GraphQL schemas using DAB CLI | https://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-export |122| Start Data API builder runtime via CLI | https://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-start |123| Control upsert behavior with If-Match in DAB REST | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/api/http-if-match |124| Use Location header for created resources in DAB | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/api/http-location |125| Use GraphQL filter argument in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/keywords/filter-graphql |126| Use $filter in REST queries for Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/keywords/filter-rest |127| Shape REST and GraphQL payloads with select | https://learn.microsoft.com/en-us/azure/data-api-builder/keywords/select-graphql |128| Project REST responses with $select in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/keywords/select-rest |129| Use SQL MCP Server DML tools for AI agents | https://learn.microsoft.com/en-us/azure/data-api-builder/mcp/data-manipulation-language-tools |130131### Deployment132| Topic | URL |133|-------|-----|134| Use the pre-deployment checklist for Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/deployment/checklist |135| Deploy Data API builder to Azure Container Apps | https://learn.microsoft.com/en-us/azure/data-api-builder/deployment/how-to-publish-container-apps |136| Deploy Data API builder to Azure Container Instances | https://learn.microsoft.com/en-us/azure/data-api-builder/deployment/how-to-publish-container-instances |137| Review Data API builder feature availability by platform | https://learn.microsoft.com/en-us/azure/data-api-builder/feature-availability |138| Deploy Data API builder with Azure SQL using AZD | https://learn.microsoft.com/en-us/azure/data-api-builder/quickstart/azure-sql |139| Deploy Data API builder to Container Apps using Azure CLI | https://learn.microsoft.com/en-us/azure/data-api-builder/tutorial-deploy-container-app-cli |140141---142> Source: [atc-net/atc-agentic-toolkit](https://github.com/atc-net/atc-agentic-toolkit) — distributed by [TomeVault](https://tomevault.io).143<!-- tomevault:4.0:skill_md:2026-06-16 -->
tomevault-io