mcpField
A
azure-data-api-builder

azure-data-api-builder

github.com/microsoftdocs開発796169 回インストール3 日前に更新
リポジトリ

azure-data-api-builder について

azure-data-api-builder は、Azure Data API builder の構成と運用に携わる開発者向けのガイダンススキルです。ローカル参照情報とリモート取得するドキュメントを組み合わせ、API、データベース、セキュリティ、MCP、デプロイを扱います。

主な機能

  1. 01REST と GraphQL の構成ガイダンス
  2. 02データベース別のトラブルシューティング
  3. 03認証と行レベルセキュリティの参照情報
  4. 04クエリ、ページネーション、ミューテーションのパターン
  5. 05Azure と Docker へのデプロイガイダンス

活用シーン

  1. 01API またはデータベース連携エラーの診断
  2. 02認証と認可方式の選択
  3. 03REST または GraphQL クエリパターンの構築
  4. 04AI エージェントからの SQL MCP ツール利用

MCP 対応

SQL MCP Server の構成、認証、トラブルシューティング、AI エージェントでの利用を扱います。また、ドキュメント取得には mcp_microsoftdocs の microsoft_docs_fetch ツールを推奨しています。

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/microsoftdocs/agent-skills --skill azure-data-api-builder

インストール後、Claude Code で/azure-data-api-builderを入力して読み込まれたか確認します。

詳細

Azure Data Api Builder スキル

このスキルでは、Azure Data Api Builder に関する専門的なガイダンスを提供します。トラブルシューティング、ベストプラクティス、意思決定、制限とクォータ、セキュリティ、構成、統合とコーディングパターン、デプロイを扱います。ローカルのクイックリファレンスコンテンツと、リモートドキュメントの取得機能を組み合わせています。

このスキルの使い方

IMPORTANT for Agent:関連するセクションを見つけるには、以下のカテゴリインデックスを使用してください。行範囲が示されているカテゴリ(例:L35-L120)では、指定された行を read_file で読み取ってください。ファイルへのリンクが示されているカテゴリ(例:[security.md](security.md))では、リンク先の参照ファイルを read_file で読み取ってください。

IMPORTANT for Agent:metadata.generated_at が3か月以上前の場合は、リポジトリから最新バージョンを取得するようユーザーに提案してください。mcp_microsoftdocs ツールを利用できない場合は、インストールするようユーザーに提案してください:インストールガイド

このスキルでドキュメントの内容を取得するには、ネットワークアクセスが必要です:

  • 推奨:クエリ文字列 from=learn-agent-skill を指定して mcp_microsoftdocs:microsoft_docs_fetch を使用してください。Markdown が返されます。
  • 代替手段:クエリ文字列 from=learn-agent-skill&accept=text/markdown を指定して fetch_webpage を使用してください。Markdown が返されます。

カテゴリインデックス

カテゴリ行説明
トラブルシューティングL36-L48DAB の問題の診断と解決:構成/CLI エラー、REST/CORS の問題、GraphQL スキーマ/認証、Cosmos DB、SQL(MCP を含む)、MySQL、PostgreSQL 固有の問題。
ベストプラクティスL49-L55セキュアで信頼性の高い Data API builder 構成の指針、SQL MCP エンティティへのセマンティックメタデータの追加、ローカル LLM で SQL MCP Server を安全に使用する方法。
意思決定L56-L61データベース/API の種類ごとの Data API builder の機能の比較と、環境に適したセキュアな Microsoft SQL 認証/認可パターンの選択。
制限とクォータL62-L69SQL タイムアウトの構成、REST/GraphQL のページサイズ制限の設定と調整、Data API builder におけるデータベース固有の制約と機能要件の理解。
セキュリティL70-L90Entra ID、JWT、EasyAuth、マネージド ID、シミュレーター、SQL 認証に加え、セキュリティのベストプラクティスを含む、Data API builder の認証、認可、行レベルセキュリティの構成。
構成L91-L133Data API builder の構成:CLI のセットアップ、JSON スキーマ、エンティティ、データソース、セキュリティ、キャッシュ、テレメトリ、ログ記録、ヘルスチェック、OpenAPI、REST/GraphQL による DB オブジェクトの公開。
統合とコーディングパターンL134-L149DAB における GraphQL/REST クエリパターン:フィルタリング、並べ替え、ページネーション、フィールド投影、スキーマのエクスポート、ミューテーションのバッチ処理、AI エージェントからの SQL MCP ツールの使用。
デプロイL150-L158ソースまたは Docker から Data API builder をビルドして実行する方法、および構成や環境固有のガイダンスを使用して Azure(App Service、Cosmos DB、エアギャップ環境/ローカル SQL)にデプロイする方法。
トラブルシューティング
トピックURL
DAB の構成を検証し、CLI の終了コードを解釈するhttps://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-validate
Data API builder の一般的な問題を解決するhttps://learn.microsoft.com/en-us/azure/data-api-builder/faq
Data API builder における Azure Cosmos DB の問題をトラブルシューティングするhttps://learn.microsoft.com/en-us/azure/data-api-builder/troubleshooting/cosmos
DAB の GraphQL スキーマと認可をトラブルシューティングするhttps://learn.microsoft.com/en-us/azure/data-api-builder/troubleshooting/graphql
Data API builder における SQL MCP サーバーの問題をトラブルシューティングするhttps://learn.microsoft.com/en-us/azure/data-api-builder/troubleshooting/mcp
Data API builder における SQL Server の問題をトラブルシューティングするhttps://learn.microsoft.com/en-us/azure/data-api-builder/troubleshooting/mssql
Data API builder における MySQL の問題をトラブルシューティングするhttps://learn.microsoft.com/en-us/azure/data-api-builder/troubleshooting/mysql
Data API builder における PostgreSQL の問題をトラブルシューティングするhttps://learn.microsoft.com/en-us/azure/data-api-builder/troubleshooting/postgresql
DAB の REST エンドポイントと CORS の問題をトラブルシューティングするhttps://learn.microsoft.com/en-us/azure/data-api-builder/troubleshooting/rest
ベストプラクティス
トピックURL
Data API builder で構成のベストプラクティスを適用するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/config/best-practices
SQL MCP サーバーのエンティティに意味的な説明を追加するhttps://learn.microsoft.com/en-us/azure/data-api-builder/mcp/how-to-add-descriptions
SQL MCP サーバーをローカル LLM と安全かつ確実に使用するhttps://learn.microsoft.com/en-us/azure/data-api-builder/mcp/use-local-models
意思決定
トピックURL
データベースと API ごとに Data API builder の機能を比較するhttps://learn.microsoft.com/en-us/azure/data-api-builder/feature-availability
Data API builder に適した Microsoft SQL のセキュリティパターンを選択するhttps://learn.microsoft.com/en-us/azure/data-api-builder/quickstart/microsoft-sql-security
制限とクォータ
トピックURL
Data API builder の SQL コマンドタイムアウトを構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/database/timeout
DAB で first を使用して GraphQL のページサイズを制限するhttps://learn.microsoft.com/en-us/azure/data-api-builder/keywords/first-graphql
DAB で $first を使用して REST のページサイズを制御するhttps://learn.microsoft.com/en-us/azure/data-api-builder/keywords/first-rest
Data API builder のデータベース固有の機能要件https://learn.microsoft.com/en-us/azure/data-api-builder/reference-database-specific-features
セキュリティ
トピックURL
Data API builder で認証モデルを選択して構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/
Data API builder でカスタム JWT 認証を構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/authenticate-custom
Data API builder で Azure App Service EasyAuth を使用するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/authenticate-easy-auth
Data API builder で Microsoft Entra ID 認証を構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/authenticate-entra
DAB SQL アクセス用に代理認証を構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/authenticate-on-behalf-of
ローカルでの DAB テストにシミュレーター認証を使用するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/authenticate-simulator
Data API builder で未認証プロバイダーを構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/authenticate-unauthenticated
Data API builder でセキュリティのベストプラクティスを適用するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/best-practices
DAB で行レベルフィルタリングを行うためのデータベースポリシーを構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/database-policies
DAB セッションコンテキストを使用して SQL の行レベルセキュリティを実装するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/row-level-security
SQL MCP Server とデータベースの認証を構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/mcp/how-to-configure-authentication
Data API builder から Azure SQL への接続にマネージド ID を使用するhttps://learn.microsoft.com/en-us/azure/data-api-builder/quickstart/authentication-managed-identity
Data API builder に Microsoft Entra 認証プロバイダーを追加するhttps://learn.microsoft.com/en-us/azure/data-api-builder/quickstart/authentication-microsoft-entra-provider
Data API builder から Azure SQL への代理認証を構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/quickstart/authentication-on-behalf-of
Data API builder エンドポイントの SQL 認証を構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/quickstart/authentication-sql-credentials
Entra ID と DAB ポリシーで Data API builder を保護するhttps://learn.microsoft.com/en-us/azure/data-api-builder/quickstart/authorization-database-policies
Data API builder で SQL の行レベルセキュリティを適用するhttps://learn.microsoft.com/en-us/azure/data-api-builder/quickstart/authorization-sql-row-level-security
構成
トピックURL
DAB CLI コマンドを使用して構成とランタイムを管理するhttps://learn.microsoft.com/en-us/azure/data-api-builder/command-line/
OpenTelemetry と App Insights を使用して DAB のテレメトリを構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-add-telemetry
dab auto-config を使用して autoentities を作成および管理するhttps://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-auto-config
dab auto-config-simulate を使用して autoentities の一致をシミュレートするhttps://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-auto-config-simulate
DAB のランタイムとデータソースの設定を構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-configure
DAB CLI を使用して Data API builder の構成を初期化するhttps://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-init
CLI を使用して Data API builder のエンティティ構成を更新するhttps://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-update
HTTP ヘッダーを使用して Data API builder のキャッシュを制御するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/cache/http-headers
Data API builder で Redis ベースのレベル 2 キャッシュを構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/cache/level-2
DAB で Azure Key Vault と @akv 関数を使用するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/config/akv-function
Data API builder で自動構成パターンを使用するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/config/auto-config
DAB の構成シークレットに @env 関数を使用するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/config/env-function
環境バリアントごとに DAB の構成を管理するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/config/environments
ハイブリッド DAB エンドポイント用に複数のデータソースを構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/config/multi-config
DAB 用に Azure Cosmos DB for NoSQL を構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/database/set-up-cosmosdb
DAB で GraphQL エンティティのリレーションシップを構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/graphql/relationships
DAB でストアドプロシージャを GraphQL オペレーションとして公開するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/graphql/stored-procedures
DAB でデータベースビューを GraphQL 型として公開するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/graphql/views
DAB の監視用に Azure Application Insights を構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/monitor/application-insights
DAB でヘルスチェックと /health エンドポイントを構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/monitor/health-checks
DAB のログ記録用に Azure Log Analytics を構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/monitor/log-analytics
Data API builder のログレベルとフィルターを構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/monitor/log-levels
DAB で OpenTelemetry のトレースとメトリックを設定するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/monitor/open-telemetry
DAB のアップサート用に If-Match ヘッダーを構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/rest/http-if-match
DAB REST における Location ヘッダーの動作を理解するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/rest/http-location
DAB REST 用に OpenAPI と Swagger UI を構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/rest/openapi
DAB でストアドプロシージャを REST エンドポイントとして公開するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/rest/stored-procedures
DAB でデータベースビューを REST エンドポイントとして公開するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/rest/views
Data API builder でロールの継承を構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/security/role-inheritance
Data API builder の完全な JSON スキーマを構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/
Data API builder の完全な JSON スキーマを構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/
Data API builder の autoentities ルールを構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/autoentities
データベース用に Data API builder の data-source セクションを構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/data-source
Data API builder の entities セクションのスキーマを構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities
Data API builder のエンティティ定義を構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/entities
Data API builder の runtime セクションを構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/runtime
Data API builder のランタイム動作を構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/configuration/runtime
SQL MCP Server でストアドプロシージャ用のカスタム MCP ツールを構成するhttps://learn.microsoft.com/en-us/azure/data-api-builder/mcp/how-to-configure-custom-tools
stdio トランスポートモードで SQL MCP Server を実行するhttps://learn.microsoft.com/en-us/azure/data-api-builder/mcp/stdio-transport
統合とコーディングパターン
トピックURL
DAB CLI を使用して GraphQL スキーマをエクスポートするhttps://learn.microsoft.com/en-us/azure/data-api-builder/command-line/dab-export
Data API builder で GraphQL を使用して集計データをクエリするhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/graphql/aggregate-data
Data API builder で複数の GraphQL ミューテーションを実行するhttps://learn.microsoft.com/en-us/azure/data-api-builder/concept/graphql/multiple-mutations
DAB で GraphQL ページネーションに after カーソルを使用するhttps://learn.microsoft.com/en-us/azure/data-api-builder/keywords/after-graphql
DAB REST で $after を使用してカーソルページネーションを実装するhttps://learn.microsoft.com/en-us/azure/data-api-builder/keywords/after-rest
DAB 固有の演算子で GraphQL クエリをフィルター処理するhttps://learn.microsoft.com/en-us/azure/data-api-builder/keywords/filter-graphql
DAB で $filter を使用して REST クエリをフィルター処理するhttps://learn.microsoft.com/en-us/azure/data-api-builder/keywords/filter-rest
DAB で orderBy を使用して GraphQL の結果を並べ替えるhttps://learn.microsoft.com/en-us/azure/data-api-builder/keywords/orderby-graphql
DAB で $orderby を使用して REST の結果を並べ替えるhttps://learn.microsoft.com/en-us/azure/data-api-builder/keywords/orderby-rest
DAB で GraphQL の選択フィールドと内部列を調整するhttps://learn.microsoft.com/en-us/azure/data-api-builder/keywords/select-graphql
DAB で $select を使用して REST フィールドを投影するhttps://learn.microsoft.com/en-us/azure/data-api-builder/keywords/select-rest
AI エージェントから SQL MCP Server の DML ツールを使用するhttps://learn.microsoft.com/en-us/azure/data-api-builder/mcp/data-manipulation-language-tools
デプロイ
トピックURL
Azure で Data API builder のデプロイオプションを選択するhttps://learn.microsoft.com/en-us/azure/data-api-builder/deployment/
エアギャップ環境に Data API builder をデプロイするhttps://learn.microsoft.com/en-us/azure/data-api-builder/deployment/air-gapped
Azure App Service に Data API builder をデプロイするhttps://learn.microsoft.com/en-us/azure/data-api-builder/deployment/azure-app-service
ソースから Data API builder をビルドして実行するhttps://learn.microsoft.com/en-us/azure/data-api-builder/deployment/run-from-source
Azure Cosmos DB NoSQL とともに Data API builder をデプロイするhttps://learn.microsoft.com/en-us/azure/data-api-builder/quickstart/basic-nosql
Docker を使用してローカル SQL とともに Data API builder をデプロイするhttps://learn.microsoft.com/en-us/azure/data-api-builder/quickstart/basic-sql

コメント