在本快速入门中,你将使用 快速入门 3:设置 Entra ID 示例,将数据 API 生成器(DAB)配置为使用 Microsoft Entra ID 身份验证提供程序。 Web 应用和 DAB 实体保持匿名,因此浏览器不需要登录 UI、MSAL 或持有者令牌。
此示例会创建一个 Microsoft Entra 应用注册,为 DAB EntraId 提供程序配置受众和颁发者,并保持 anonymous 角色处于活动状态。 此模式允许在需要登录之前添加令牌验证基础结构。
先决条件
- .NET 8 或更高版本
- Docker Desktop
- PowerShell
- 用于本地业务流程的 .NET Aspire 工具
- 用于 Microsoft Entra 设置和 Azure 部署的 Azure CLI
- sqlpackage(如果部署数据库项目)
- 具有创建 Azure SQL、Azure 容器应用、Azure 容器注册表、Log Analytics 和资源组权限的 Azure 订阅
- 创建或重复使用Microsoft Entra应用注册的权限
示例显示的内容
- 无需用户登录即可调用 DAB 的静态 Web 应用。
- 使用
EntraId身份验证提供程序配置的 DAB。 - 用于提供 DAB API 受众和签发者的 Microsoft Entra 应用注册。
- 使
anonymous角色保持活动状态的实体权限。 - 包含
authenticated角色的实体权限,以便 DAB 可以接受有效的 Bearer 令牌。 - 从 DAB 到本地SQL Server开发容器的 SQL 身份验证。
- DAB 通过系统分配的托管标识无密码访问 Azure SQL。
- 针对本地 SQL Server、DAB、web 应用、SQL Commander 和 MCP Inspector 的 .NET Aspire 编排。
- 通过 PowerShell 脚本在
azure-infra中进行 Azure 部署和清理。
身份验证流程
| 跳 | 本地身份验证 | Azure身份验证 |
|---|---|---|
| 从用户到 Web 应用 | 匿名 | 匿名 |
| Web 应用到 API | 匿名 | 匿名 |
| API 身份验证提供程序 |
EntraId,包含匿名实体 |
EntraId,包含匿名实体 |
| API 转 SQL | SQL 身份验证 | 系统分配的托管标识 |
Important
DAB API 会验证Microsoft Entra令牌,但匿名实体权限仍允许未经身份验证的请求。 仅当 Web 应用发送持有者令牌时,才添加更严格的权限。
与该系列比较
| Step | 哪些更改 |
|---|---|
| 上一个 | 使用托管标识后,无需 Azure SQL 密码,但 Web 应用和 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。 该脚本创建或配置应用注册、更新受众和颁发者,然后启动本地资源。
Web 应用匿名加载。 DAB 已在幕后配置好 EntraId 提供程序。
将示例部署到Azure。
pwsh ./azure-infra/azure-up.ps1
部署脚本为 DAB、Web 应用、MCP 检查器和 SQL 指挥官预配Azure SQL和Azure 容器应用资源。 还会为 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.html、web-app/app.js、web-app/dab.js、web-app/config.js |
保持匿名且不使用 MSAL 的静态 Web 文件。 |
使用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.