1---2name: azure-data-api-builder3description: Azure Data Api Builder Skill4---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**: 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 file1213> **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)1415This skill requires **network access** to fetch documentation content:16- **Preferred**: Use `mcp_microsoftdocs:microsoft_docs_fetch` with query string `from=learn-agent-skill`. Returns Markdown.17- **Fallback**: Use `fetch_webpage` with query string `from=learn-agent-skill&accept=text/markdown`. Returns Markdown.1819## Category Index2021| Category | Lines | Description |22|----------|-------|-------------|23| 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. |24| 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. |25| 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. |26| Limits & Quotas | L53-L59 | Configuring SQL command timeouts and controlling response sizes in Data API builder using GraphQL `first` and REST `$first` pagination limits. |27| Security | L60-L71 | Configuring authentication/authorization for DAB: roles/permissions, Entra ID, EasyAuth, custom JWT, simulator auth, SQL row-level security, and SQL MCP Server auth. |28| Configuration | L72-L124 | Configuring DAB: CLI-based config management, entities and data sources, caching, secrets/env configs, OpenAPI/GraphQL, logging/telemetry, health, and provider-specific settings. |29| Integrations & Coding Patterns | L125-L137 | 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. |30| Deployment | L138-L146 | 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. |3132### Troubleshooting33| Topic | URL |34|-------|-----|35| Resolve common issues with Data API builder (FAQ) | https://learn.microsoft.com/en-us/azure/data-api-builder/faq |3637### Best Practices38| Topic | URL |39|-------|-----|40| Apply configuration best practices for Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/deployment/best-practices-configuration |41| Apply security and connectivity best practices for DAB | https://learn.microsoft.com/en-us/azure/data-api-builder/deployment/best-practices-security |42| Add semantic descriptions to SQL MCP entities for AI | https://learn.microsoft.com/en-us/azure/data-api-builder/mcp/how-to-add-descriptions |4344### Decision Making45| Topic | URL |46|-------|-----|47| Choose Azure hosting options for Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/deployment/hosting-options |4849### Limits & Quotas50| Topic | URL |51|-------|-----|52| Configure SQL Server command timeout in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/how-to/configure-timeout |53| Control GraphQL page size with first in DAB | https://learn.microsoft.com/en-us/azure/data-api-builder/keywords/first-graphql |54| Limit REST page size with $first in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/keywords/first-rest |5556### Security57| Topic | URL |58|-------|-----|59| Configure roles and permissions for authorization in DAB | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/authorization |60| 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 |61| Configure custom JWT authentication providers in DAB | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/how-to-authenticate-custom |62| 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 |63| Use Simulator authentication for local DAB permission testing | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/how-to-authenticate-simulator |64| 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 |65| Implement SQL row-level security with DAB session context | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/row-level-security |66| Configure authentication for SQL MCP Server and database | https://learn.microsoft.com/en-us/azure/data-api-builder/mcp/how-to-configure-authentication |6768### Configuration69| Topic | URL |70|-------|-----|71| Use Data API builder CLI commands to manage configs | https://learn.microsoft.com/en-us/azure/data-api-builder/command-line/ |72| Add entities to Data API builder configuration with CLI | https://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-add |73| Configure Data API builder runtime and data source via CLI | https://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-configure |74| Initialize Data API builder configuration files with CLI | https://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-init |75| Update Data API builder entity definitions with CLI | https://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-update |76| Validate Data API builder configuration files in CI/CD | https://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-validate |77| Configure OpenAPI and Swagger for DAB REST APIs | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/api/openapi |78| Control Data API builder caching via HTTP headers | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/cache/http-headers |79| Configure internal level 1 cache in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/cache/level-1 |80| Configure external Redis level 2 cache in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/cache/level-2 |81| Load secrets from Azure Key Vault with @akv in DAB | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/config/akv-function |82| Reference environment variables with @env in DAB config | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/config/env-function |83| Use environment-specific config files in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/config/environments |84| Configure multiple data sources and hybrid endpoints in DAB | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/config/multi-data-source |85| Configure entity relationships for GraphQL in DAB | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/database/relationships |86| Expose stored procedures as endpoints in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/database/stored-procedures |87| Expose database views as DAB REST/GraphQL endpoints | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/database/views |88| Configure Azure Application Insights monitoring for DAB | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/monitor/application-insights |89| Configure and use the /health endpoint in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/monitor/health-checks |90| Configure Azure Log Analytics integration for DAB | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/monitor/log-analytics |91| Set filtered log levels in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/monitor/log-levels |92| Enable OpenTelemetry tracing and metrics in DAB | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/monitor/open-telemetry |93| Full configuration schema for Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/ |94| Reference schema for Data API builder configuration file | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/ |95| Configure Data API builder data source section | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/data-source |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 entities section in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities |106| Configure entities section in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities |107| Configure entities section in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities |108| Configure runtime settings for Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/runtime |109| Configure runtime settings for Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/runtime |110| Configure runtime settings for Data API builder | 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 Data API builder runtime behavior | 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 runtime settings for Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/runtime |115| Configure runtime settings for Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/runtime |116| Configure Data API builder runtime behavior | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/runtime |117| Configure Data API builder runtime behavior | https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/runtime |118| Configure DAB for Azure Cosmos DB for NoSQL | https://learn.microsoft.com/en-us/azure/data-api-builder/how-to/set-up-cosmosdb |119| Configure stdio transport mode for SQL MCP Server | https://learn.microsoft.com/en-us/azure/data-api-builder/mcp/stdio-transport |120121### Integrations & Coding Patterns122| Topic | URL |123|-------|-----|124| Export GraphQL schemas using DAB CLI | https://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-export |125| Start Data API builder runtime via CLI | https://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-start |126| Control upsert behavior with If-Match in DAB REST | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/api/http-if-match |127| Use Location header for created resources in DAB | https://learn.microsoft.com/en-us/azure/data-api-builder/concept/api/http-location |128| Use GraphQL filter argument in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/keywords/filter-graphql |129| Use $filter in REST queries for Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/keywords/filter-rest |130| Shape REST and GraphQL payloads with select | https://learn.microsoft.com/en-us/azure/data-api-builder/keywords/select-graphql |131| Project REST responses with $select in Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/keywords/select-rest |132| Use SQL MCP Server DML tools for AI agents | https://learn.microsoft.com/en-us/azure/data-api-builder/mcp/data-manipulation-language-tools |133134### Deployment135| Topic | URL |136|-------|-----|137| Use the pre-deployment checklist for Data API builder | https://learn.microsoft.com/en-us/azure/data-api-builder/deployment/checklist |138| Deploy Data API builder to Azure Container Apps | https://learn.microsoft.com/en-us/azure/data-api-builder/deployment/how-to-publish-container-apps |139| Deploy Data API builder to Azure Container Instances | https://learn.microsoft.com/en-us/azure/data-api-builder/deployment/how-to-publish-container-instances |140| Review Data API builder feature availability by platform | https://learn.microsoft.com/en-us/azure/data-api-builder/feature-availability |141| Deploy Data API builder with Azure SQL using AZD | https://learn.microsoft.com/en-us/azure/data-api-builder/quickstart/azure-sql |142| 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 |
ComeOnOliver