Skillshub azure-data-api-builder

Azure Data Api Builder Skill

install
source · Clone the upstream repo
git clone https://github.com/ComeOnOliver/skillshub
Claude Code · Install into ~/.claude/skills/
T=$(mktemp -d) && git clone --depth=1 https://github.com/ComeOnOliver/skillshub "$T" && mkdir -p ~/.claude/skills && cp -r "$T/skills/MicrosoftDocs/Agent-Skills/azure-data-api-builder" ~/.claude/skills/comeonoliver-skillshub-azure-data-api-builder && rm -rf "$T"
manifest: skills/MicrosoftDocs/Agent-Skills/azure-data-api-builder/SKILL.md
source content

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: 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
TroubleshootingL36-L40FAQ-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 PracticesL41-L47Configuring DAB for reliability and performance, securing and connecting it to data sources, and adding semantic metadata to SQL MCP entities for AI consumption.
Decision MakingL48-L52Guidance 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 & QuotasL53-L59Configuring SQL command timeouts and controlling response sizes in Data API builder using GraphQL
first
and REST
$first
pagination limits.
SecurityL60-L71Configuring authentication/authorization for DAB: roles/permissions, Entra ID, EasyAuth, custom JWT, simulator auth, SQL row-level security, and SQL MCP Server auth.
ConfigurationL72-L124Configuring DAB: CLI-based config management, entities and data sources, caching, secrets/env configs, OpenAPI/GraphQL, logging/telemetry, health, and provider-specific settings.
Integrations & Coding PatternsL125-L137Using 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.
DeploymentL138-L146Deploying 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

TopicURL
Resolve common issues with Data API builder (FAQ)https://learn.microsoft.com/en-us/azure/data-api-builder/faq

Best Practices

TopicURL
Apply configuration best practices for Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/deployment/best-practices-configuration
Apply security and connectivity best practices for DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/deployment/best-practices-security
Add semantic descriptions to SQL MCP entities for AIhttps://learn.microsoft.com/en-us/azure/data-api-builder/mcp/how-to-add-descriptions

Decision Making

TopicURL
Choose Azure hosting options for Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/deployment/hosting-options

Limits & Quotas

TopicURL
Configure SQL Server command timeout in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/how-to/configure-timeout
Control GraphQL page size with first in DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/keywords/first-graphql
Limit REST page size with $first in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/keywords/first-rest

Security

TopicURL
Configure roles and permissions for authorization in DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/authorization
Use Azure App Service EasyAuth with Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/how-to-authenticate-app-service
Configure custom JWT authentication providers in DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/how-to-authenticate-custom
Configure Microsoft Entra ID authentication for Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/how-to-authenticate-entra
Use Simulator authentication for local DAB permission testinghttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/how-to-authenticate-simulator
Configure database policies for row-level filtering in DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/how-to-configure-database-policies
Implement SQL row-level security with DAB session contexthttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/row-level-security
Configure authentication for SQL MCP Server and databasehttps://learn.microsoft.com/en-us/azure/data-api-builder/mcp/how-to-configure-authentication

Configuration

TopicURL
Use Data API builder CLI commands to manage configshttps://learn.microsoft.com/en-us/azure/data-api-builder/command-line/
Add entities to Data API builder configuration with CLIhttps://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-add
Configure Data API builder runtime and data source via CLIhttps://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-configure
Initialize Data API builder configuration files with CLIhttps://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-init
Update Data API builder entity definitions with CLIhttps://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-update
Validate Data API builder configuration files in CI/CDhttps://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-validate
Configure OpenAPI and Swagger for DAB REST APIshttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/api/openapi
Control Data API builder caching via HTTP headershttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/cache/http-headers
Configure internal level 1 cache in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/cache/level-1
Configure external Redis level 2 cache in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/cache/level-2
Load secrets from Azure Key Vault with @akv in DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/config/akv-function
Reference environment variables with @env in DAB confighttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/config/env-function
Use environment-specific config files in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/config/environments
Configure multiple data sources and hybrid endpoints in DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/config/multi-data-source
Configure entity relationships for GraphQL in DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/database/relationships
Expose stored procedures as endpoints in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/database/stored-procedures
Expose database views as DAB REST/GraphQL endpointshttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/database/views
Configure Azure Application Insights monitoring for DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/monitor/application-insights
Configure and use the /health endpoint in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/monitor/health-checks
Configure Azure Log Analytics integration for DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/monitor/log-analytics
Set filtered log levels in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/monitor/log-levels
Enable OpenTelemetry tracing and metrics in DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/monitor/open-telemetry
Full configuration schema for Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/
Reference schema for Data API builder configuration filehttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/
Configure Data API builder data source sectionhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/data-source
Configure entities section in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities
Configure entities section in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities
Configure entities section in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities
Configure entities section in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities
Configure entities section in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities
Configure entities section in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities
Configure entities section in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities
Configure entities section in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities
Configure entities section in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities
Configure entities section in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities
Configure entities section in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities
Configure entities section in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities
Configure runtime settings for Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/runtime
Configure runtime settings for Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/runtime
Configure runtime settings for Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/runtime
Configure runtime settings for Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/runtime
Configure Data API builder runtime behaviorhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/runtime
Configure Data API builder runtime behaviorhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/runtime
Configure runtime settings for Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/runtime
Configure runtime settings for Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/runtime
Configure Data API builder runtime behaviorhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/runtime
Configure Data API builder runtime behaviorhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/runtime
Configure DAB for Azure Cosmos DB for NoSQLhttps://learn.microsoft.com/en-us/azure/data-api-builder/how-to/set-up-cosmosdb
Configure stdio transport mode for SQL MCP Serverhttps://learn.microsoft.com/en-us/azure/data-api-builder/mcp/stdio-transport

Integrations & Coding Patterns

TopicURL
Export GraphQL schemas using DAB CLIhttps://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-export
Start Data API builder runtime via CLIhttps://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-start
Control upsert behavior with If-Match in DAB RESThttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/api/http-if-match
Use Location header for created resources in DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/api/http-location
Use GraphQL filter argument in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/keywords/filter-graphql
Use $filter in REST queries for Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/keywords/filter-rest
Shape REST and GraphQL payloads with selecthttps://learn.microsoft.com/en-us/azure/data-api-builder/keywords/select-graphql
Project REST responses with $select in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/keywords/select-rest
Use SQL MCP Server DML tools for AI agentshttps://learn.microsoft.com/en-us/azure/data-api-builder/mcp/data-manipulation-language-tools

Deployment

TopicURL
Use the pre-deployment checklist for Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/deployment/checklist
Deploy Data API builder to Azure Container Appshttps://learn.microsoft.com/en-us/azure/data-api-builder/deployment/how-to-publish-container-apps
Deploy Data API builder to Azure Container Instanceshttps://learn.microsoft.com/en-us/azure/data-api-builder/deployment/how-to-publish-container-instances
Review Data API builder feature availability by platformhttps://learn.microsoft.com/en-us/azure/data-api-builder/feature-availability
Deploy Data API builder with Azure SQL using AZDhttps://learn.microsoft.com/en-us/azure/data-api-builder/quickstart/azure-sql
Deploy Data API builder to Container Apps using Azure CLIhttps://learn.microsoft.com/en-us/azure/data-api-builder/tutorial-deploy-container-app-cli