快速入門:在 Data API 建構器中新增 Microsoft Entra 提供者

在這個快速入門中,你會使用 快速入門 3:設定 Entra ID 範例,將 Data API 建構器(DAB)設定為使用 Microsoft Entra ID 驗證提供者。 網頁應用程式和 DAB 實體保持匿名,因此瀏覽器不需要登入介面、MSAL 或持有憑證。

此範例會建立 Microsoft Entra 應用程式註冊,將 DAB EntraId 提供者設定為使用受眾和簽發者,並讓 anonymous 角色維持啟用狀態。 這個模式讓你在需要登入前就先加入代幣驗證基礎設施。

先決條件

  • .NET 8 或更高
  • Docker 桌面
  • PowerShell
  • .NET Aspire 工具 用於本地協調
  • Azure CLI 用於Microsoft Entra設定與Azure部署
  • 如果你部署資料庫專案,請使用 SQL套件
  • 具有建立 Azure SQL、Azure 容器應用程式、Azure Container Registry、Log Analytics 和資源群組權限的 Azure 訂用帳戶
  • 建立或重用 Microsoft Entra 應用程式註冊的權限

樣本顯示的內容

  • 一個靜態網頁應用程式,無需使用者登入即可呼叫 DAB。
  • DAB 已設定為使用 EntraId 驗證提供者。
  • Microsoft Entra 應用程式註冊,提供 DAB API 的對象與簽發者。
  • 使 anonymous 角色保持啟用狀態的實體權限。
  • 包含 authenticated 角色的實體權限,讓 DAB 能接受有效的持有人令牌。
  • 從 DAB 到 本地 SQL Server 開發容器的 SQL 認證。
  • 透過系統指派的管理身份,無需密碼即可存取 Azure SQL。
  • .NET Aspire 為本地 SQL Server、DAB、網頁應用程式、SQL Commander 及 MCP Inspector 進行編排。
  • azure-infra 中透過 PowerShell 指令碼進行 Azure 的部署和清理。

身份驗證流程

本地驗證 Azure 身份驗證
使用者對網頁應用程式 匿名 匿名
網頁應用程式轉 API 匿名 匿名
API 認證提供者 EntraId,與匿名實體 EntraId,包含匿名實體
API 轉 SQL SQL 驗證 系統指派的管理身份識別

Important

DAB API 會驗證 Microsoft Entra 的憑證,但匿名實體權限仍允許未經認證的請求。 只有當網頁應用程式傳送承載令牌時,才加更嚴格的權限。

與系列比較

Step 改變了什麼
上一個 Use managed identity 移除Azure SQL密碼,但讓網頁應用程式和 API 保持匿名。
本快速入門 新增 Microsoft Entra 提供者、受眾及發行者,同時保持匿名存取有效。
下一步 使用 DAB 政策處理每位使用者資料, 需登入並以 DAB 政策表達式過濾資料列。

請使用範例

複製樣本庫。

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

恢復本地工具。

dotnet tool restore

登入Azure。

az login

在本機上執行範例。

dotnet run --project aspire-apphost

首次執行時,Aspire 會檢查 dab-config.json 中是否有 Microsoft Entra 預留位置。 如果提供者尚未設定,應用程式會提供以互動方式執行 azure-infra/entra-setup.ps1 的選項。 腳本會建立或設定應用程式註冊,更新受眾和發行者,然後啟動本地資源。

網頁應用程式是匿名載入的。 DAB 在幕後由 EntraId 供應商設定。

將範例部署到 Azure。

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

部署腳本會為 Azure SQL 和 Azure 容器應用程式 資源提供 DAB、網頁應用、MCP Inspector 和 SQL Commander。 它同時為 DAB 容器應用程式配置系統指派的管理身份,並將 Microsoft Entra 受眾與發行者傳給 DAB。

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

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

清理程序會執行 Microsoft Entra 拆解指令碼。 如果你需要另外移除應用程式註冊,請從樣本中執行 azure-infra/entra-teardown.ps1

關鍵檔案

路徑 Purpose
data-api/dab-config.json 定義 EntraId 認證提供者、受眾、發行者及實體角色。
aspire-apphost/Demo.cs 檢查 dab-config.json 中的 Microsoft Entra 預留位置,並引導進行本機設定。
azure-infra/entra-setup.ps1 建立或設定應用程式註冊及 API 受眾。
azure-infra/entra-teardown.ps1 拆除時會刪除應用程式註冊。
web-app/index.htmlweb-app/app.jsweb-app/dab.jsweb-app/config.js 靜態網頁檔案,保持匿名且不使用 MSAL。

使用 GitHub Copilot 來重現這個範例

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

You are GitHub Copilot running in agent mode. Recreate the Data API builder Quickstart 3 Microsoft Entra provider sample as a complete, runnable project in the current VS Code workspace under `quickstart-03-entra-provider`. Build a static anonymous web app, DAB with the `EntraId` provider configured, local SQL Server with SQL authentication, Azure SQL with managed identity, REST, GraphQL, MCP, .NET Aspire, SQL Commander, MCP Inspector, and Azure Container Apps deployment scripts. Keep the web app anonymous and keep entities callable through the `anonymous` role. Do not add MSAL, sign-in UI, token acquisition, or bearer-token calls to the web app in this quickstart.

Source repository: https://github.com/Azure-Samples/dab-2.0-quickstart-web_anon-api_entra-db_entra. 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.

Start with a short plan and proceed with safe defaults before you create files or run commands. Use the default demo schema unless the user requests a custom 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 a new Microsoft Entra app registration for the DAB API audience or reuse an existing app ID URI, audience, and issuer?
- Do you approve creating billable Azure resources and a Microsoft Entra app registration if the deployment phase starts?

After the answers, show a checklist and ask for approval before implementation. Include phases for local scaffold, Entra setup, local validation, Azure infrastructure, Azure validation, and cleanup. Do not run `az`, `az ad`, 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; otherwise choose the lowest-cost SQL option that supports managed identity and Microsoft Entra validation. 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 use `az ad` commands, `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 init`: https://learn.microsoft.com/azure/data-api-builder/command-line/dab-init
- `dab add`: https://learn.microsoft.com/azure/data-api-builder/command-line/dab-add
- `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
- Microsoft Entra authentication in DAB: https://learn.microsoft.com/azure/data-api-builder/concept/security/authenticate-entra

Create this structure under the sample folder:

- `azure-infra/` for Bicep, `azure-up.ps1`, `azure-down.ps1`, `entra-setup.ps1`, `entra-teardown.ps1`, and post-provision scripts.
- `data-api/` for `dab-config.json` and a DAB Dockerfile that bakes the config into the image for Azure.
- `database/` for a SQL Database Project or idempotent SQL scripts with seed data.
- `web-app/` for static anonymous HTML, CSS, and JavaScript.
- `aspire-apphost/` for the .NET Aspire AppHost.
- `mcp-inspector/` for MCP Inspector notes or container assets.

Handle secrets and generated values first. Add `.env`, `**/bin`, and `**/obj` to `.gitignore` before writing secrets. Use `MSSQL_CONNECTION_STRING`, `ENTRA_TENANT_ID`, `ENTRA_AUDIENCE`, and `ENTRA_ISSUER`. Never print tokens or secret values. Use `@env(...)` placeholders in `dab-config.json` where practical.

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: the local Aspire web origin, such as `http://localhost:5173`, and the deployed Azure Container Apps web FQDN if Azure deployment is approved. Keep `allow-credentials` set to `false` unless the sample explicitly uses 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 local config and validation:

```dotnetcli
dab init --database-type mssql --connection-string "@env('MSSQL_CONNECTION_STRING')" --auth.provider EntraID --auth.audience "@env('ENTRA_AUDIENCE')" --auth.issuer "@env('ENTRA_ISSUER')" --host-mode Development --rest.enabled true --graphql.enabled true --mcp.enabled true
dab add Todos --source dbo.Todos --source.type table --permissions "anonymous:read"
dab validate --config data-api/dab-config.json
```

Use this DAB configuration shape if you write the config directly:

```json
{
	"data-source": {
		"database-type": "mssql",
		"connection-string": "@env('MSSQL_CONNECTION_STRING')"
	},
	"runtime": {
		"rest": { "enabled": true, "path": "/api" },
		"graphql": { "enabled": true, "path": "/graphql" },
		"mcp": { "enabled": true, "path": "/mcp" },
		"host": {
			"mode": "development",
			"authentication": {
				"provider": "EntraId",
				"jwt": {
					"audience": "@env('ENTRA_AUDIENCE')",
					"issuer": "@env('ENTRA_ISSUER')"
				}
			}
		}
	}
}
```

Keep anonymous entity permissions active. Also include `authenticated` where useful so a valid bearer token for the configured audience resolves to the `authenticated` role, but do not require tokens for the web app in this quickstart.

Use these Aspire patterns from the quickstart skills. Use `.WaitForCompletion(sqlDatabaseProject)` for DAB and SQL Commander when a SQL project deploys schema.

```csharp
var dabServer = builder.AddContainer("data-api", "azure-databases/data-api-builder", "latest")
		.WithImageRegistry("mcr.microsoft.com")
		.WithBindMount(new FileInfo("data-api/dab-config.json").FullName, "/App/dab-config.json", isReadOnly: true)
		.WithEnvironment("MSSQL_CONNECTION_STRING", sqlDatabase)
		.WithEnvironment("ENTRA_AUDIENCE", entraAudience)
		.WithEnvironment("ENTRA_ISSUER", entraIssuer)
		.WithHttpEndpoint(targetPort: 5000, name: "http")
		.WithHttpHealthCheck("/health")
		.WaitForCompletion(sqlDatabaseProject);
```

Add SQL Commander with image `jerrynixon/sql-commander:latest`, env var `ConnectionStrings__db`, and a connection string that includes `TrustServerCertificate=true`.

```csharp
var sqlCommander = builder.AddContainer("sql-cmdr", "jerrynixon/sql-commander", "latest")
		.WithImageRegistry("docker.io")
		.WithHttpEndpoint(targetPort: 8080, name: "http")
		.WithEnvironment("ConnectionStrings__db", sqlDatabase)
		.WithHttpHealthCheck("/health")
		.WaitForCompletion(sqlDatabaseProject);
```

Add MCP Inspector with Streamable HTTP transport and omit auth only for local development.

```csharp
var mcpInspector = builder.AddMcpInspector("mcp-inspector")
		.WithMcpServer(dabServer, transportType: McpTransportType.StreamableHttp)
		.WithEnvironment("DANGEROUSLY_OMIT_AUTH", "true")
		.WaitFor(dabServer);
```

For Azure, configure the DAB Container App with a system-assigned managed identity and a passwordless Azure SQL connection string. Bake `dab-config.json` into the DAB image and replace CORS or endpoint placeholders before image build.

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

Validate before reporting success:

- `dab validate --config data-api/dab-config.json` exits with code 0.
- `dotnet run --project aspire-apphost` starts the complete local environment.
- A direct database query confirms the seeded table exists and contains rows.
- DAB `/health` returns a 2xx 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 loads anonymously and does not contain MSAL code.
- REST and GraphQL return seeded rows anonymously.
- A valid bearer token for the configured audience is accepted by DAB and maps to `authenticated`.
- MCP Inspector can list DAB tools and call `describe_entities` or an equivalent DAB MCP tool.
- SQL Commander opens and shows seeded tables.
- The web site returns a successful HTTP response.
- The app registration, audience, issuer, and tenant match DAB configuration.
- In Azure, the DAB Container App has a system-assigned managed identity and uses passwordless 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.