azure-data-api-builder について
azure-data-api-builder は、Azure Data API builder の構成と運用に携わる開発者向けのガイダンススキルです。ローカル参照情報とリモート取得するドキュメントを組み合わせ、API、データベース、セキュリティ、MCP、デプロイを扱います。
主な機能
- 01REST と GraphQL の構成ガイダンス
- 02データベース別のトラブルシューティング
- 03認証と行レベルセキュリティの参照情報
- 04クエリ、ページネーション、ミューテーションのパターン
- 05Azure と Docker へのデプロイガイダンス
活用シーン
- 01API またはデータベース連携エラーの診断
- 02認証と認可方式の選択
- 03REST または GraphQL クエリパターンの構築
- 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-L48 | DAB の問題の診断と解決:構成/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-L69 | SQL タイムアウトの構成、REST/GraphQL のページサイズ制限の設定と調整、Data API builder におけるデータベース固有の制約と機能要件の理解。 |
| セキュリティ | L70-L90 | Entra ID、JWT、EasyAuth、マネージド ID、シミュレーター、SQL 認証に加え、セキュリティのベストプラクティスを含む、Data API builder の認証、認可、行レベルセキュリティの構成。 |
| 構成 | L91-L133 | Data API builder の構成:CLI のセットアップ、JSON スキーマ、エンティティ、データソース、セキュリティ、キャッシュ、テレメトリ、ログ記録、ヘルスチェック、OpenAPI、REST/GraphQL による DB オブジェクトの公開。 |
| 統合とコーディングパターン | L134-L149 | DAB における GraphQL/REST クエリパターン:フィルタリング、並べ替え、ページネーション、フィールド投影、スキーマのエクスポート、ミューテーションのバッチ処理、AI エージェントからの SQL MCP ツールの使用。 |
| デプロイ | L150-L158 | ソースまたは Docker から Data API builder をビルドして実行する方法、および構成や環境固有のガイダンスを使用して Azure(App Service、Cosmos DB、エアギャップ環境/ローカル SQL)にデプロイする方法。 |
トラブルシューティング
ベストプラクティス
| トピック | 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 |
|---|---|
| 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 |