快速入門：使用資料 API 建構器中的代為認證

在這個快速入門中，你會使用 Quickstart 6 On-Behalf-Of Flow 範例來執行 Data API 建構器（DAB），並使用使用者委派的認證。 網頁應用程式以 Microsoft Entra ID 登入使用者，將持有人令牌傳送給 DAB，DAB 則將每個令牌交換為已登入使用者的 Azure SQL 令牌。

範例使用 Azure SQL，因為本地 SQL Server 無法接受 Microsoft Entra 令牌。 執行WhoAmISELECT SUSER_NAME()的檢視證明 SQL 看到的是實際呼叫者，而非 DAB 管理身份。

先決條件

• .NET 8 或更高
• Docker 桌面
• PowerShell
• .NET Aspire 工具用於建置協調
• Azure CLI 用於Microsoft Entra設定與Azure部署
• 如果你部署資料庫專案，請使用 SQL套件
• 具有建立 Azure SQL、Azure 容器應用程式、Azure Container Registry、Log Analytics 和資源群組權限的 Azure 訂用帳戶
• 建立 Microsoft Entra 應用程式註冊的權限、建立 API 應用程式用戶端密碼、新增 Azure SQL Database 的委派 user_impersonation 權限，以及授與管理員同意
• 可成為 Azure SQL Microsoft Entra 系統管理員的 Microsoft Entra 使用者或群組

樣本顯示的內容

• 一個靜態網頁應用程式，使用 MSAL 瀏覽器登入。
• 網頁應用程式對 DAB 的持有人令牌呼叫。
• DAB 已設定為使用 Microsoft Entra ID EntraId 驗證提供者。
• DAB user-delegated-auth 配置為 OBO 令牌交換。
• 用於 OBO 交換且具有用戶端密碼的 API 應用程式註冊。
• Azure SQL Database在管理員同意下授權了 user_impersonation 權限。
• 一個不含 User ID、Password 或 Authentication 關鍵字的純 Azure SQL 連線字串。
• 已驗證的 DAB 實體，不允許匿名存取。
• 供已登入呼叫端使用的 Azure SQL 內含使用者
• 一個 WhoAmI 回傳 SUSER_NAME() 以驗證 SQL 呼叫者身份的視圖。
• 在 azure-infra 中透過 PowerShell 指令碼進行 Azure 的部署和清理。

身份驗證流程

跳	Authentication
使用者對網頁應用程式	使用 Microsoft Entra ID 進行 MSAL 瀏覽器登入
網頁應用程式到 DAB API	DAB API 受眾的持有人代幣
DAB API 的角色	authenticated
DAB to Azure SQL	實際登入使用者的 OBO 代幣

與系列比較

Step	改變了什麼
上一個	使用 SQL 的列層級安全 過濾 SQL 中的列，但 SQL 仍會驗證 DAB 服務身份。
本快速入門	使用 OBO，因此 Azure SQL 會驗證實際登入使用者的身份，以便進行審計和使用者感知政策。
下一步	「配置 OBO 認證 」詳細說明了 OBO 的設定屬性。

僅限 Azure 的行為

OBO 需要 Azure SQL 搭配 Microsoft Entra 認證。 本地的 SQL Server 容器無法接受 Microsoft Entra 令牌，因此完整的 OBO 路徑僅限 Azure。

使用未包含驗證資訊的 Azure SQL 連線字串，讓 DAB 能在每個已驗證的要求中為每位使用者注入 OBO 權杖。

Server=tcp:<server>.database.windows.net,1433;Database=<database>;Encrypt=True;TrustServerCertificate=False;

請不要在 OBO 連接字串 中包含以下數值：

• User ID
• Password
• Authentication

Important

若連接字串包含 Authentication=，當 DAB 同時提供存取權杖時，SQL 用戶端函式庫會拒絕該請求。

請使用範例

複製樣本庫。

git clone https://github.com/Azure-Samples/dab-2.0-quickstart-web_entra-api_entra-db_entra-obo.git
cd dab-2.0-quickstart-web_entra-api_entra-db_entra-obo

恢復本地工具。

dotnet tool restore

登入Azure。

az login

將範例部署到 Azure。

pwsh ./azure-infra/azure-up.ps1

部署腳本會為 Azure SQL 和 Azure 容器應用程式 資源提供 DAB、網頁應用、MCP Inspector 和 SQL Commander。 它也會執行 Microsoft Entra 設定、建立 API 應用程式的用戶端密碼、新增 Azure SQL Database 的委派 user_impersonation 權限、授與管理員同意、部署資料庫、建立內含使用者，以及為 OBO 設定 DAB。

部署後，打開腳本列印的網頁應用程式網址。 登入並確認 SQL Server 識別你為 的徽章顯示你的使用者主體名稱。 徽章上寫著由 SELECT SUSER_NAME() 支持的 WhoAmI 實體。

匿名 API 請求應該會回傳 401 Unauthorized。

完成後清理 Azure 資源和應用程式註冊。

pwsh ./azure-infra/azure-down.ps1

關鍵檔案

路徑	Purpose
data-api/dab-config.json	啟用 user-delegated-auth、停用快取、設定 EntraId並暴露 WhoAmI 檢視實體。
database/Views/WhoAmI.sql	定義 SELECT SUSER_NAME() AS UserName 用於身份驗證。
web-app/index.html	顯示已登入的使用者和 SQL 身份徽章。
web-app/app.js	協調登入、頁面更新及身份更新。
web-app/dab.js	向 DAB 發送持有者令牌請求並讀取 WhoAmI。
azure-infra/entra-setup.ps1	建立 Microsoft Entra 應用程式註冊、建立 API 用戶端密碼、新增 Azure SQL Database 委派權限 user_impersonation，並授與系統管理員同意。
azure-infra/resources.bicep	定義 Azure 資源，並將原始 Azure SQL 連線字串和 OBO 設定傳遞給 DAB。
azure-infra/post-provision.ps1	部署資料庫、設定Azure SQL Microsoft Entra管理員、建立包含的使用者，並設定 OBO 環境值。

使用 GitHub Copilot 來重現這個範例

在 Visual Studio Code 中開啟你想建立範例的工作區，將 GitHub Copilot 切換成代理模式，然後貼上這個提示。

You are GitHub Copilot running in agent mode. Recreate the Data API builder Quickstart 6 On-Behalf-Of Flow sample as a complete Azure-only project in the current VS Code workspace under `quickstart-06-on-behalf-of`. Build a static SPA with MSAL browser sign-in, DAB with Microsoft Entra bearer-token validation and OBO user-delegated authentication, Azure SQL, REST, GraphQL, MCP, .NET Aspire build orchestration, SQL Commander, MCP Inspector, and Azure Container Apps deployment scripts. DAB is the only API, GraphQL, and MCP layer over SQL. SQL must authenticate the actual signed-in user, not the DAB managed identity or service principal.

Source repository: https://github.com/Azure-Samples/dab-2.0-quickstart-web_entra-api_entra-db_entra-obo. If internet access is available, inspect or clone this repository before you create files. Reuse and adapt its files as closely as possible, especially `web-app/`, `data-api/`, `database/`, `aspire-apphost/`, `mcp-inspector/`, `azure-infra/`, scripts, and README patterns. The goal is to implement the published quickstart, not to invent a different sample. If the repository differs from this prompt or the current Data API builder docs, prefer the current docs for product behavior.

Minimize user interaction. Use the defaults in this prompt and make reasonable best guesses for noncritical choices. Do not ask for a root folder or project folder name; use the current VS Code workspace and the default subfolder. Ask only when you need approval for resource changes, secrets, permissions, materially higher cost, external account choices, or an ambiguous requirement that affects the architecture.

Azure-only constraint: do not build a local SQL Server OBO path. Local SQL Server cannot accept Microsoft Entra tokens. Use local tooling only for project generation, web app development, DAB config validation where possible, container builds, and database package builds.

Start with a short plan and proceed with safe defaults before you create files or run commands. Use the default `WhoAmI` view unless the user explicitly asks for additional schema. Ask only these questions if the values aren't already available from the environment or prior context:

- Which Azure subscription, primary region, fallback region, resource group, and tenant should the sample use? Default fallback region: `westus2` if the primary region can't provision Azure SQL or Container Apps.
- Should I create new SPA and API app registrations or reuse existing registrations?
- Confirm that the API app can use a client secret. OBO requires a confidential client.
- Confirm that the API app should receive Azure SQL Database delegated `user_impersonation` permission and admin consent.
- Which Microsoft Entra user or group should become the Azure SQL Microsoft Entra admin?
- Which signed-in users or groups should become contained database users for validation?
- Do you approve creating billable Azure resources, app registrations, and an API app client secret if deployment starts?

After the answers, show a checklist and ask for approval before implementation. Include phases for scaffold, Entra setup, database package, Azure infrastructure, post-provision, validation, and cleanup. Do not run `az`, `az ad`, `azd`, or Azure deployment commands that create or change resources until the user explicitly approves the exact command set.

After approval, continue working without asking status-check questions. If a command, build, container, endpoint, or validation step fails, inspect the error, adjust the project, rerun the step, and continue. Keep iterating until the sample runs end-to-end or you hit a blocker that requires user action.

Use cost-first Azure defaults. Choose the cheapest option that satisfies the quickstart requirements: use a free Azure SQL database offer when the subscription and region support it and it supports Microsoft Entra/OBO validation; otherwise choose the lowest-cost SQL option that supports user-delegated authentication. Use Azure Container Apps consumption, minimal CPU and memory, Basic Azure Container Registry, minimal Log Analytics retention, and no always-on or dedicated plans unless required. Prioritize finishing the project. Treat regional provisioning limits as expected adjustment points, not failures: if the primary region can't provision a required service or free SQL option, use the approved fallback region such as `westus2`, and continue the deployment. Ask the user only when both the primary and fallback regions can't satisfy the requirements, when a change would materially increase cost, when a new permission is required, or when you need approval for Azure commands that create or change resources beyond the already-approved plan. Keep every resource minimal, but make the web interface neat and approachable: small code footprint, responsive layout, clear status messages, accessible labels, and simple styling that is polished rather than austere.

Verify prerequisites and report only missing items: .NET SDK, Docker Desktop running, PowerShell, Azure CLI signed in, permission to create app registrations and grant admin consent, `sqlpackage`, .NET Aspire tooling, and the DAB CLI. Use these docs while building:

- DAB CLI reference: https://learn.microsoft.com/azure/data-api-builder/command-line/
- `dab configure` OBO options: https://learn.microsoft.com/azure/data-api-builder/command-line/dab-configure
- `dab validate`: https://learn.microsoft.com/azure/data-api-builder/command-line/dab-validate
- DAB MCP overview: https://learn.microsoft.com/azure/data-api-builder/mcp/overview
- OBO concept: https://learn.microsoft.com/azure/data-api-builder/concept/security/authenticate-on-behalf-of
- User-delegated auth configuration: https://learn.microsoft.com/azure/data-api-builder/configuration/data-source#user-delegated-auth

Create this structure under the sample folder:

- `azure-infra/` for Bicep, `azure-up.ps1`, `azure-down.ps1`, `entra-setup.ps1`, `entra-teardown.ps1`, `resources.bicep`, and `post-provision.ps1`.
- `data-api/` for `dab-config.json` and a DAB Dockerfile that bakes the config into the image.
- `database/` for a SQL Database Project, seed data, and `Views/WhoAmI.sql`.
- `web-app/` for static HTML, CSS, and JavaScript with MSAL browser support.
- `aspire-apphost/` for build orchestration only.
- `mcp-inspector/` for MCP Inspector container assets and nginx same-origin proxy config.

Handle secrets first. Add `.env`, `**/bin`, and `**/obj` to `.gitignore` before writing secrets or local configuration. Store the API client secret only in local `.env` files for local preparation and in Azure Key Vault or Azure Container Apps secrets for Azure. Never inline secret values in Bicep, PowerShell scripts, generated JSON, logs, or reports. Generate secret references for Container Apps instead of plaintext environment values. Never print tokens, passwords, or client secret values. Redact all secret values as `***redacted***`.

Configure DAB CORS before you start or deploy the web app. Do not leave `runtime.host.cors.origins` as `[]`. Set it to include the exact web app origins, including scheme and port: any local web origin used for development and the deployed Azure Container Apps web FQDN. Keep `allow-credentials` set to `false` because this SPA sends bearer tokens, not browser credentials or cookies. Direct REST, GraphQL, or Swagger requests can succeed even when the browser blocks JavaScript fetch calls, so browser-origin CORS must be configured and validated separately.

Use this DAB CLI workflow for config shaping and validation where possible:

```dotnetcli
dab init --database-type mssql --connection-string "@env('DATABASE_CONNECTION_STRING')" --auth.provider EntraID --auth.audience "@env('ENTRA_AUDIENCE')" --auth.issuer "@env('ENTRA_ISSUER')" --rest.enabled true --graphql.enabled true --mcp.enabled true
dab configure --data-source.user-delegated-auth.enabled true --data-source.user-delegated-auth.provider EntraId --data-source.user-delegated-auth.database-audience "https://database.windows.net"
dab add WhoAmI --source dbo.vw_WhoAmI --source.type view --source.key-fields "UserName" --permissions "authenticated:read" --mcp.dml-tools true
dab validate --config data-api/dab-config.json
```

Use a bare Azure SQL connection string so DAB can inject the per-user OBO access token. Do not include `User ID`, `Password`, or `Authentication`.

```text
Server=tcp:<server>.database.windows.net,1433;Database=<database>;Encrypt=True;TrustServerCertificate=False;
```

Use this DAB data-source shape for OBO:

```json
{
	"data-source": {
		"database-type": "mssql",
		"connection-string": "@env('DATABASE_CONNECTION_STRING')",
		"user-delegated-auth": {
			"enabled": true,
			"provider": "EntraId",
			"database-audience": "https://database.windows.net"
		}
	}
}
```

Create `database/Views/WhoAmI.sql` to prove SQL sees the signed-in user.

```sql
CREATE VIEW dbo.vw_WhoAmI AS
SELECT CAST(SUSER_NAME() AS nvarchar(256)) AS UserName;
```

Implement the SPA with MSAL browser. `web-app/dab.js` must send bearer tokens to DAB on every protected request.

```javascript
export async function getAuthHeaders() {
	const token = await acquireAccessToken();
	return { Authorization: `Bearer ${token}` };
}
```

For Azure, bake `dab-config.json` into the DAB image. Do not rely on volume mounts in Azure Container Apps.

```dockerfile
FROM mcr.microsoft.com/azure-databases/data-api-builder:latest
COPY dab-config.json /App/dab-config.json
```

Before any Azure post-provision command, list the exact `az`, `az acr`, `az containerapp`, and `sqlpackage` commands you intend to run and wait for explicit user approval. Post-provision in this order: deploy dacpac, set the Azure SQL Microsoft Entra admin, create contained database users or groups for validation, grant access to demo objects and `WhoAmI`, replace placeholders, build and push the DAB image, then update Container Apps.

```powershell
dotnet build database/database.sqlproj -c Release
sqlpackage /Action:Publish /SourceFile:database/bin/Release/database.dacpac /TargetConnectionString:"$sqlConn" /p:BlockOnPossibleDataLoss=false
az acr build --registry $acrName --image dab-api:latest --file ./data-api/Dockerfile ./data-api/
az containerapp update --name $dabAppName --resource-group $resourceGroup --image "$acrName.azurecr.io/dab-api:latest"
```

Deploy MCP Inspector with a same-origin proxy pattern and set `MCP_SERVER_URL` to the DAB `/mcp` endpoint.

```nginx
location /mcp {
	proxy_pass http://127.0.0.1:6277;
	proxy_http_version 1.1;
	proxy_set_header Upgrade $http_upgrade;
	proxy_set_header Connection "upgrade";
	proxy_buffering off;
}
```

Deploy SQL Commander with env var `ConnectionStrings__db` and ensure the connection string includes `TrustServerCertificate=true`.

```text
ConnectionStrings__db=Server=<server>.database.windows.net;Database=<database>;User Id=<user>;Password=<password>;TrustServerCertificate=true
```

Validation must prove OBO, not only API authentication:

- A direct Azure SQL query confirms the database is reachable, the deployed objects exist, and required contained users or groups exist.
- DAB `/health` returns a 2xx response.
- The web site returns a successful HTTP response.
- A browser-origin request from each web app origin receives an `Access-Control-Allow-Origin` response header that matches that origin.
- The web app signs in with Microsoft Entra ID.
- Signed-in REST, GraphQL, and MCP calls include bearer headers and reach DAB under the `authenticated` role.
- The `WhoAmI` entity returns the signed-in user's UPN from `SUSER_NAME()`.
- `WhoAmI` does not return the DAB managed identity, service principal, or Container App identity.
- Anonymous REST and GraphQL calls return `401`.
- The DAB Container App database connection string contains no SQL password, no `User ID`, and no `Authentication` keyword.
- The API client secret exists only as a secret reference or redacted local value.
- MCP Inspector connects to DAB MCP with streamable HTTP.
- SQL Commander can browse the deployed schema.
- Required contained users or groups exist in Azure SQL.

Do not report final URLs, asset locations, or a success summary until you directly verify database connectivity and query results, a 2xx DAB health response, and a successful web site response. This validation ensures the sample works without requiring the developer to check.

Troubleshoot with these checks:

- OBO token exchange fails: verify the API app has Azure SQL Database delegated `user_impersonation` permission and admin consent.
- SQL login fails for a token-identified principal: add the signed-in user or group as a contained user in the database.
- DAB returns 401 for valid bearer tokens: verify audience and issuer values in `dab-config.json`.
- SQL sees the service identity instead of the user: verify `user-delegated-auth`, the API client secret, and the bare SQL connection string.

相關內容

• 資料 API 產生器快速入門
• 快速入門：使用 SQL 列級安全性搭配 Data API 建構器
• 設定 On-Behalf-Of 使用者委派驗證
• 使用者委派認證設定參考
• 快速入門：將 Microsoft Entra 提供者新增至 Data API builder
• Data API 產生器中的 Microsoft Entra ID 驗證
• Data API 建構器 2.0 版新增內容