TypingMindTypingMindThe best frontend for AI
Azure Data Api Builder logo

Azure Data Api Builder

Organization
MicrosoftDocs
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 exposing DB objects via REST/GraphQL, tuning paging/timeouts, securing auth/RLS, or deploying DAB to Azure, and other Azure Data Api Builder related development tasks. Not for Azure API Management (use azure-api-management), Azure App Service (use azure-app-service), Azure Functions (use azure-functions), Azure Logic Apps (use azure-logic-apps).

Overview

PublisherMicrosoftDocs
RepositoryAgent-Skills
Skill nameazure-data-api-builder
Stars
778
Forks
126
Bundled files
Instructions only
LicenseCC-BY-4.0
Links
Skill sourceRepositoryHomepage
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • Self-contained

    Everything the model needs lives in the instructions — no extra files to sync.

  • Open source

    Published by MicrosoftDocs on GitHub. Read the source before you install it.

Installation

Install the Azure Data Api Builder AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
    https://github.com/MicrosoftDocs/Agent-Skills/tree/main/skills/azure-data-api-builder
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/MicrosoftDocs/Agent-Skills.git /tmp/Agent-Skills
mkdir -p .claude/skills
cp -r /tmp/Agent-Skills/skills/azure-data-api-builder .claude/skills/azure-data-api-builder
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Azure Data Api Builder in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Azure Data Api Builder on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Azure Data Api Builder is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

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-L48Diagnosing and fixing DAB issues: config/CLI errors, REST/CORS problems, GraphQL schema/auth, and database-specific troubles for Cosmos DB, SQL (incl. MCP), MySQL, and PostgreSQL.
Best PracticesL49-L55Guidance on secure, reliable Data API builder configs, adding semantic metadata to SQL MCP entities, and safely using SQL MCP Server with local LLMs.
Decision MakingL56-L61Comparing Data API builder capabilities across databases/API types and choosing secure Microsoft SQL authentication/authorization patterns for your setup.
Limits & QuotasL62-L69Configuring SQL timeouts, setting and tuning REST/GraphQL page size limits, and understanding database-specific constraints and feature requirements in Data API builder.
SecurityL70-L90Configuring authentication, authorization, and row-level security for Data API builder, including Entra ID, JWT, EasyAuth, managed identity, simulator, and SQL auth, plus security best practices.
ConfigurationL91-L133Configuring Data API builder: CLI setup, JSON schema, entities, data sources, security, caching, telemetry, logging, health checks, OpenAPI, and exposing DB objects via REST/GraphQL.
Integrations & Coding PatternsL134-L149GraphQL/REST query patterns in DAB: filtering, sorting, pagination, field projection, exporting schemas, batching mutations, and using SQL MCP tools from AI agents.
DeploymentL150-L158How to build and run Data API builder from source or Docker, and deploy it to Azure (App Service, Cosmos DB, air‑gapped/local SQL) with configuration and environment-specific guidance.

Troubleshooting

TopicURL
Validate DAB configuration and interpret CLI exit codeshttps://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-validate
Resolve common issues in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/faq
Troubleshoot Azure Cosmos DB issues in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/troubleshooting/cosmos
Troubleshoot GraphQL schema and authorization in DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/troubleshooting/graphql
Troubleshoot SQL MCP Server issues in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/troubleshooting/mcp
Troubleshoot SQL Server issues in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/troubleshooting/mssql
Troubleshoot MySQL issues in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/troubleshooting/mysql
Troubleshoot PostgreSQL issues in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/troubleshooting/postgresql
Troubleshoot REST endpoint and CORS issues in DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/troubleshooting/rest

Best Practices

TopicURL
Apply configuration best practices in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/config/best-practices
Add semantic descriptions to SQL MCP Server entitieshttps://learn.microsoft.com/en-us/azure/data-api-builder/mcp/how-to-add-descriptions
Use SQL MCP Server with local LLMs securely and reliablyhttps://learn.microsoft.com/en-us/azure/data-api-builder/mcp/use-local-models

Decision Making

TopicURL
Compare Data API builder features by database and APIhttps://learn.microsoft.com/en-us/azure/data-api-builder/feature-availability
Choose Microsoft SQL security patterns for Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/quickstart/microsoft-sql-security

Limits & Quotas

TopicURL
Configure SQL command timeout for Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/database/timeout
Limit GraphQL page size with first in DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/keywords/first-graphql
Control REST page size with $first in DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/keywords/first-rest
Database-specific feature requirements for Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/reference-database-specific-features

Security

TopicURL
Select and configure authentication models in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/
Configure custom JWT authentication for Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/authenticate-custom
Use Azure App Service EasyAuth with Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/authenticate-easy-auth
Configure Microsoft Entra ID auth for Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/authenticate-entra
Configure On-Behalf-Of authentication for DAB SQL accesshttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/authenticate-on-behalf-of
Use Simulator authentication for local DAB testinghttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/authenticate-simulator
Configure Unauthenticated provider in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/authenticate-unauthenticated
Apply security best practices in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/best-practices
Configure database policies for row-level filtering in DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/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
Use managed identity for Data API builder to Azure SQLhttps://learn.microsoft.com/en-us/azure/data-api-builder/quickstart/authentication-managed-identity
Add Microsoft Entra authentication provider to Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/quickstart/authentication-microsoft-entra-provider
Configure on-behalf-of authentication from Data API builder to Azure SQLhttps://learn.microsoft.com/en-us/azure/data-api-builder/quickstart/authentication-on-behalf-of
Configure SQL authentication for Data API builder endpointshttps://learn.microsoft.com/en-us/azure/data-api-builder/quickstart/authentication-sql-credentials
Secure Data API builder with Entra ID and DAB policieshttps://learn.microsoft.com/en-us/azure/data-api-builder/quickstart/authorization-database-policies
Apply SQL row-level security with Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/quickstart/authorization-sql-row-level-security

Configuration

TopicURL
Use DAB CLI commands to manage configuration and runtimehttps://learn.microsoft.com/en-us/azure/data-api-builder/command-line/
Configure DAB telemetry with OpenTelemetry and App Insightshttps://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-add-telemetry
Create and manage autoentities via dab auto-confighttps://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-auto-config
Simulate autoentities matches with dab auto-config-simulatehttps://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-auto-config-simulate
Configure DAB runtime and data source settingshttps://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-configure
Initialize Data API builder config with DAB CLIhttps://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-init
Update Data API builder entity configuration via CLIhttps://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-update
Control Data API builder caching via HTTP headershttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/cache/http-headers
Configure Redis-based level 2 cache in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/cache/level-2
Use @akv function with Azure Key Vault in DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/config/akv-function
Use auto configuration patterns in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/config/auto-config
Use @env function for DAB configuration secretshttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/config/env-function
Manage DAB configuration by environment variantshttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/config/environments
Configure multiple data sources for hybrid DAB endpointshttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/config/multi-config
Configure Azure Cosmos DB for NoSQL with DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/database/set-up-cosmosdb
Configure GraphQL entity relationships in DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/graphql/relationships
Expose stored procedures as GraphQL operations in DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/graphql/stored-procedures
Expose database views as GraphQL types in DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/graphql/views
Configure Azure Application Insights for DAB monitoringhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/monitor/application-insights
Configure health checks and /health endpoint in DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/monitor/health-checks
Configure Azure Log Analytics for DAB logginghttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/monitor/log-analytics
Configure Data API builder logging levels and filtershttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/monitor/log-levels
Set up OpenTelemetry tracing and metrics in DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/monitor/open-telemetry
Configure If-Match header for DAB upsertshttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/rest/http-if-match
Understand Location header behavior in DAB RESThttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/rest/http-location
Configure OpenAPI and Swagger UI for DAB RESThttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/rest/openapi
Expose stored procedures as REST endpoints in DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/rest/stored-procedures
Expose database views as REST endpoints in DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/rest/views
Configure role inheritance in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/role-inheritance
Configure full Data API builder JSON schemahttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/
Configure full Data API builder JSON schemahttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/
Configure Data API builder autoentities ruleshttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/autoentities
Configure Data API builder data-source section for databaseshttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/data-source
Configure Data API builder entities section schemahttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities
Configure Data API builder entity definitionshttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities
Configure runtime section of 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 custom MCP tools for stored procedures in SQL MCP Serverhttps://learn.microsoft.com/en-us/azure/data-api-builder/mcp/how-to-configure-custom-tools
Run SQL MCP Server in stdio transport modehttps://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
Query aggregate data via GraphQL in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/graphql/aggregate-data
Execute multiple GraphQL mutations in Data API builderhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/graphql/multiple-mutations
Use after cursors for GraphQL pagination in DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/keywords/after-graphql
Implement cursor pagination with $after in DAB RESThttps://learn.microsoft.com/en-us/azure/data-api-builder/keywords/after-rest
Filter GraphQL queries with DAB-specific operatorshttps://learn.microsoft.com/en-us/azure/data-api-builder/keywords/filter-graphql
Filter REST queries with $filter in DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/keywords/filter-rest
Sort GraphQL results with orderBy in DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/keywords/orderby-graphql
Sort REST results with $orderby in DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/keywords/orderby-rest
Shape GraphQL selections and internal columns in DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/keywords/select-graphql
Use $select to project REST fields in DABhttps://learn.microsoft.com/en-us/azure/data-api-builder/keywords/select-rest
Use SQL MCP Server DML tools from AI agentshttps://learn.microsoft.com/en-us/azure/data-api-builder/mcp/data-manipulation-language-tools

Deployment

TopicURL
Choose Data API builder deployment option in Azurehttps://learn.microsoft.com/en-us/azure/data-api-builder/deployment/
Deploy Data API builder in air-gapped environmentshttps://learn.microsoft.com/en-us/azure/data-api-builder/deployment/air-gapped
Deploy Data API builder to Azure App Servicehttps://learn.microsoft.com/en-us/azure/data-api-builder/deployment/azure-app-service
Build and run Data API builder from sourcehttps://learn.microsoft.com/en-us/azure/data-api-builder/deployment/run-from-source
Deploy Data API builder with Azure Cosmos DB NoSQLhttps://learn.microsoft.com/en-us/azure/data-api-builder/quickstart/basic-nosql
Deploy Data API builder with local SQL via Dockerhttps://learn.microsoft.com/en-us/azure/data-api-builder/quickstart/basic-sql

Frequently asked questions

What does the Azure Data Api Builder AI skill do?

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 exposing DB objects via REST/GraphQL, tuning paging/timeouts, securing auth/RLS, or deploying DAB to Azure, and other Azure Data Api Builder related development tasks. Not for Azure API Management (use azure-api-management), Azure App Service (use azure-app-service), Azure Functions (use azure-functions), Azure Logic Apps (use azure-logic-apps).

Why use Azure Data Api Builder on TypingMind?

Because you install it once and use it with any model. Azure Data Api Builder is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Azure Data Api Builder in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/MicrosoftDocs/Agent-Skills/tree/main/skills/azure-data-api-builder. TypingMind reads its SKILL.md and installs it as a skill you can enable per chat.

Which AI models can use Azure Data Api Builder?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Azure Data Api Builder?

As many as you like. As long as a model supports skills, you can use Azure Data Api Builder with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Azure Data Api Builder AI skill free?

Yes. It is published on GitHub by MicrosoftDocs under the CC-BY-4.0 license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

Related AI Skills

View all
garrytan logo

Canary

garrytan
CommunityPopular

Post-deploy canary monitoring. (gstack)

19.9K
133.5K
1 files
View
garrytan logo

Land And Deploy

garrytan
CommunityPopular

Land and deploy workflow. (gstack)

19.9K
133.5K
8 files
View
openclaw logo

Clawsweeper

openclaw
OrganizationPopular

Use for all ClawSweeper work: OpenClaw issue/PR sweep reports, repair jobs, cloud fix PRs, @clawsweeper maintainer mention commands, trusted ClawSweeper-reviewed autofix/automerge, GitHub Actions…

82.2K
391K
1 files
View
openclaw logo

Openclaw Ci Limits

openclaw
OrganizationPopular

Manage OpenClaw GitHub Actions and Blacksmith CI capacity, runner-registration budgets, fanout caps, main-push single-flight, shard sizing, hosted-runner offload, queue health, and safe…

82.2K
391K
1 files
View

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇