Data API Builder のデプロイ オプションを確認する
Data API Builder をローカル開発から Azure 運用環境に移行するには、適切なホスティング プラットフォームを選択し、デプロイの自動化を構成する必要があります。 Azure には、DAB を実行するためのいくつかのオプションが用意されており、それぞれスケーラビリティ、管理オーバーヘッド、および他の Azure サービスとの統合の特性が異なります。
デプロイ戦略は、DAB の実行場所だけでなく、構成の管理、シークレットの処理、需要に合わせてスケーリングする方法にも影響します。 これらのデプロイ オプションを理解すると、アプリケーションアーキテクチャと運用要件に最も適したアプローチを選択するのに役立ちます。
Azure Container Apps へのデプロイ
Azure Container Apps には、インフラストラクチャ管理を自動的に処理するサーバーレス コンテナー プラットフォームが用意されています。 Data API Builder は、アイドル時にゼロからスケーリングでき、要求ボリュームに基づいて自動的にスケールアップできるため、最適です。
DAB を Container Apps にデプロイするには、まず、構成を使用してコンテナー イメージを作成します。
FROM mcr.microsoft.com/azure-databases/data-api-builder:latest
COPY dab-config.json /App/dab-config.json
ENV DATABASE_CONNECTION_STRING=""
ENV ASPNETCORE_URLS="http://+:5000"
EXPOSE 5000
この Dockerfile は、公式の DAB イメージから開始し、構成ファイルを追加します。 環境変数は、接続文字列とポート構成を処理します。
Azure CLI を使用してデプロイします。
az containerapp create \
--name dab-api \
--resource-group myResourceGroup \
--environment myContainerAppEnv \
--image myregistry.azurecr.io/dab-api:v1 \
--target-port 5000 \
--ingress external \
--secrets database-conn="<connection-string>" \
--env-vars DATABASE_CONNECTION_STRING=secretref:database-conn
Container Apps は、シークレット管理のために Azure Key Vault と統合されます。 構成ファイルまたはコンテナー イメージに資格情報を格納するのではなく、環境変数でシークレットを参照します。
ヒント
Azure Container Apps のマネージド ID を有効にし、Azure SQL Database へのアクセス権を付与します。 この方法では、Microsoft Entra 認証を使用して、保存されている資格情報を完全に排除します。
Azure App Service へのデプロイ
Azure App Service には、組み込みのデプロイ スロット、カスタム ドメイン、包括的な監視を備えた成熟したプラットフォームが用意されています。 App Service を既に使用しているチームの場合、DAB の追加は使い慣れたパターンに従います。
DAB コンテナーを実行するように App Service を構成します。
az webapp create \
--name dab-api \
--resource-group myResourceGroup \
--plan myAppServicePlan \
--deployment-container-image-name mcr.microsoft.com/azure-databases/data-api-builder:latest
App Service 構成を使用して環境変数を設定します。
az webapp config appsettings set \
--name dab-api \
--resource-group myResourceGroup \
--settings DATABASE_CONNECTION_STRING="@Microsoft.KeyVault(SecretUri=https://myvault.vault.azure.net/secrets/db-connection)"
Key Vault 参照構文を使用すると、App Service は実行時にシークレットをプルし、構成でシークレットを公開しません。 App Service でシステム割り当てマネージド ID を有効にし、Key Vault へのアクセス権を付与します。
Azure Static Web Apps へのデプロイ
Azure Static Web Apps には、データベース接続と呼ばれる組み込み機能として Data API Builder が含まれています。 この統合により、API が静的フロントエンドを補完する最も簡単なデプロイ エクスペリエンスが提供されます。
Azure portal または CLI を使用してデータベースをリンクします。
az staticwebapp dbconnection create \
--name myStaticWebApp \
--resource-group myResourceGroup \
--db-type mssql \
--db-resource-id /subscriptions/.../servers/myserver/databases/mydb
リポジトリ内の staticwebapps.database.config.json ファイルは、スタンドアロン DAB と同じ構造を使用してエンティティ構成を定義します。
{
"data-source": {
"database-type": "mssql"
},
"entities": {
"Product": {
"source": "dbo.Products",
"permissions": [
{ "role": "anonymous", "actions": ["read"] }
]
}
}
}
Static Web Apps は、組み込みの認証プロバイダーとの認証統合を自動的に処理します。 API ルートは、既定で /.auth/ パスと /data-api/ パスの下に表示されます。
注
Static Web Apps のデータベース接続には、制限付きストアド プロシージャのサポートなど、スタンドアロン DAB と比較していくつかの制限があります。 現在利用可能な機能については、ドキュメントを参照してください。
CI/CD デプロイ パイプラインを実装する
自動デプロイ パイプラインにより、環境間で一貫した構成が確保され、迅速な反復が可能になります。 GitHub Actions は、DAB デプロイに簡単なアプローチを提供します。
.github/workflows/deploy-dab.ymlでワークフロー ファイルを作成します。
name: Deploy Data API Builder
on:
push:
branches: [main]
paths:
- 'dab-config*.json'
- 'Dockerfile'
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Login to Azure Container Registry
uses: azure/docker-login@v1
with:
login-server: ${{ secrets.ACR_LOGIN_SERVER }}
username: ${{ secrets.ACR_USERNAME }}
password: ${{ secrets.ACR_PASSWORD }}
- name: Build and push container
run: |
docker build -t ${{ secrets.ACR_LOGIN_SERVER }}/dab-api:${{ github.sha }} .
docker push ${{ secrets.ACR_LOGIN_SERVER }}/dab-api:${{ github.sha }}
- name: Deploy to Container Apps
uses: azure/container-apps-deploy-action@v1
with:
resourceGroup: myResourceGroup
containerAppName: dab-api
imageToDeploy: ${{ secrets.ACR_LOGIN_SERVER }}/dab-api:${{ github.sha }}
このワークフローは、構成ファイルまたは Dockerfile への変更をトリガーします。 新しいコンテナー イメージをビルドし、Azure Container Registry にプッシュして、Container App を更新します。
環境固有のデプロイを構成する
本番環境へのデプロイメントでは、環境を慎重に分離する必要があります。 環境固有の構成ファイルをデプロイ変数と組み合わせて使用します。
複数の構成ファイルを使用してリポジトリを構成します。
/
├── dab-config.json # Base configuration (shared settings)
├── dab-config.development.json
├── dab-config.staging.json
├── dab-config.production.json
└── Dockerfile
ビルド引数を受け入れるように Dockerfile を変更します。
FROM mcr.microsoft.com/azure-databases/data-api-builder:latest
ARG ENVIRONMENT=production
COPY dab-config.json /App/dab-config.json
COPY dab-config.${ENVIRONMENT}.json /App/dab-config.${ENVIRONMENT}.json
ENV DAB_ENVIRONMENT=${ENVIRONMENT}
環境固有のイメージをビルドします。
docker build --build-arg ENVIRONMENT=production -t dab-api:production .
Important
ソース管理にコミットされた構成ファイルに、実際の接続文字列やシークレットを含めてはいけません。 環境変数参照 (@env()) を使用し、Azure Key Vault またはデプロイ パイプラインのシークレット管理を使用してシークレットを管理します。
展開の正常性を監視する
デプロイ後、DAB が正しく動作することを確認するように正常性チェックを構成します。 Container Apps と App Service では、正常性プローブがサポートされます。
{
"probes": [
{
"type": "liveness",
"httpGet": {
"path": "/",
"port": 5000
},
"periodSeconds": 30
},
{
"type": "readiness",
"httpGet": {
"path": "/api/Product?$first=1",
"port": 5000
},
"periodSeconds": 10
}
]
}
ライブネス プローブは、DAB が応答していることを確認します。 準備プローブは、実際の API 要求を行ってデータベース接続を検証します。 異常なインスタンスを自動的に再起動するようにオーケストレーション プラットフォームを構成します。