快速入門：搭配 Data API Builder 使用受控識別

在這個快速入門中，你會使用 Quickstart 2 管理身份範例來執行 Data API 建構器（DAB），並以無需密碼存取Azure SQL。 範例使用使用者對網頁應用程式的匿名存取、網頁應用程式對 DAB 的匿名存取，以及系統指派的管理身份從 DAB 轉到 Azure SQL。

範例透過 REST、GraphQL 和 MCP 暴露 SQL 資料。 它也包含 .NET Aspire 本地編排與 Azure 部署腳本。

Important

本地路徑可使用 SQL 認證作為開發備援。 Azure 路徑使用管理身份，且在 DAB 設定中沒有 SQL 密碼。

先決條件

  • .NET 8 或更高
  • Docker 桌面
  • PowerShell
  • .NET Aspire 工具 用於本地協調
  • Azure CLI 用於Azure部署
  • 如果你部署資料庫專案，請使用 SQL套件
  • 具有建立 Azure SQL、Azure 容器應用程式、Azure Container Registry、Log Analytics 和資源群組權限的 Azure 訂用帳戶
  • 可成為 Azure SQL Microsoft Entra 系統管理員的 Microsoft Entra 使用者或群組

樣本顯示的內容

  • 一個靜態網頁應用程式，無需使用者登入即可呼叫 DAB。
  • DAB 被設定為建構於 SQL 之上的唯一 API、GraphQL 與 MCP 層。
  • 從 DAB 到 本地 SQL Server 開發容器的 SQL 認證。
  • 透過系統指派的受控識別，無需密碼即可讓 DAB 存取 Azure SQL。
  • 已設定 Microsoft Entra 系統管理員的 Azure SQL。
  • 一個為 DAB 管理身份所建立的包含式資料庫使用者。
  • db_datareader 以及 db_datawriter DAB 身份的角色授權。
  • .NET Aspire 為本地 SQL Server、DAB、網頁應用程式、SQL Commander 及 MCP Inspector 進行編排。
  • 在 azure-infra 中透過 PowerShell 指令碼進行 Azure 的部署與清理。

身份驗證流程

跳 本地驗證 Azure 身份驗證
使用者對網頁應用程式 匿名 匿名
網頁應用程式轉 API 匿名 匿名
API 轉 SQL SQL 驗證 系統指派的管理身份識別

與系列比較

Step 改變了什麼
上一個 使用 SQL 認證 ，儲存一個 SQL 憑證以便 DAB 轉 SQL 存取。
這個快速入門 透過系統指派的管理身份移除 Azure SQL 密碼。
下一步 新增 Microsoft Entra 提供者，即可在保留匿名 API 存取的同時設定權杖驗證。

請使用範例

複製樣本庫。

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

在本機上執行範例。

dotnet tool restore
dotnet run --project aspire-apphost

Aspire 儀表板會在 http://localhost:15888 開啟。 網頁應用程式會在 http://localhost:5173 開啟。 使用儀表板檢查 DAB 端點、SQL Server 容器、MCP Inspector 和 SQL Commander 資源。

將範例部署到 Azure。

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

部署腳本會為 Azure SQL 和 Azure 容器應用程式 資源提供 DAB、網頁應用、MCP Inspector 和 SQL Commander。 它還會設定 DAB 容器應用程式使用系統指派的管理身份，並配置一個無密碼的 Azure SQL 連接字串，形狀如下。

Server=tcp:<sql-server>.database.windows.net,1433;Database=<database>;Authentication=Active Directory Default;Encrypt=True;TrustServerCertificate=False;

後續佈建指令碼會設定 Azure SQL 的 Microsoft Entra 系統管理員、為 DAB 受控識別建立自主資料庫使用者，並授予 db_datareader 與 db_datawriter。

完成後清理 Azure 資源。

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

關鍵檔案

路徑 Purpose
azure-infra/resources.bicep 定義 Azure 資源、在 DAB 容器應用程式上啟用 SystemAssigned 身分識別，並設定 Azure SQL 的無密碼連線字串。
azure-infra/main.bicep 協調部署並輸出 DAB 容器應用程式主體 ID。
azure-infra/post-provision.ps1 設定 Azure SQL 的 Microsoft Entra 管理員，為 DAB 身分建立獨立資料庫使用者，並授與資料庫角色。
data-api/dab-config.json DAB 執行時配置，支援 SQL、REST、GraphQL、MCP 及匿名實體存取。
database SQL 資料庫專案、結構檔案與種子資料腳本。
web-app 靜態網頁應用程式，可以匿名呼叫 DAB。
aspire-apphost .NET Aspire AppHost 負責協調本地容器和專案資源。

使用 GitHub Copilot 來重現這個範例

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

You are GitHub Copilot running in agent mode. Recreate the Data API builder Quickstart 2 Managed Identity sample as a complete, runnable project in the current VS Code workspace under `quickstart-02-managed-identity`. Build a static web app, DAB, local SQL Server with SQL authentication for development, Azure SQL with system-assigned managed identity for Azure, REST, GraphQL, MCP, .NET Aspire, SQL Commander, MCP Inspector, and Azure Container Apps deployment scripts. DAB is the only API, GraphQL, and MCP layer over SQL.

Source repository: https://github.com/Azure-Samples/dab-2.0-quickstart-web_anon-api_anon-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, and resource group should Azure deployment use? Default fallback region: `westus2` if the primary region can't provision Azure SQL or Container Apps.
- Which Microsoft Entra user or group should become the Azure SQL Microsoft Entra admin?
- Do you approve creating billable Azure resources if the deployment phase starts?

After the answers, show a checklist and ask for approval before implementation. Include phases for local scaffold, local validation, Azure infrastructure, managed identity database grants, Azure validation, and cleanup. Do not run any Azure command that creates or changes 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. 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, `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

Create this structure under the sample folder:

- `azure-infra/` for Bicep, `azure-up.ps1`, `azure-down.ps1`, and `post-provision.ps1`.
- `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 HTML, CSS, and JavaScript that calls DAB anonymously.
- `aspire-apphost/` for the .NET Aspire AppHost.
- `mcp-inspector/` for MCP Inspector notes or container assets.

Handle secrets first. Add `.env`, `**/bin`, and `**/obj` to `.gitignore` before writing secrets. Use `MSSQL_CONNECTION_STRING` locally. Never print secret values. Use `@env('MSSQL_CONNECTION_STRING')` in local `dab-config.json`.

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')" --host-mode Development --rest.enabled true --graphql.enabled true --mcp.enabled true
dab add Todos --source dbo.Todos --source.type table --permissions "anonymous:read" --mcp.dml-tools true
dab validate --config data-api/dab-config.json
```

Use this Azure SQL connection string shape for the Azure Container App. The Azure DAB configuration must not contain `User ID=` or `Password=`.

```text
Server=tcp:<sql-server>.database.windows.net,1433;Database=<database>;Authentication=Active Directory Default;Encrypt=True;TrustServerCertificate=False;
```

Enable system-assigned identity on the DAB Container App and output its principal ID for post-provisioning.

```bicep
identity: {
  type: 'SystemAssigned'
}
```

In post-provisioning, set the Azure SQL Microsoft Entra admin, deploy the schema, create a contained database user for the DAB managed identity, and grant least required database roles.

```sql
CREATE USER [<dab-container-app-name>] FROM EXTERNAL PROVIDER;
ALTER ROLE db_datareader ADD MEMBER [<dab-container-app-name>];
ALTER ROLE db_datawriter ADD MEMBER [<dab-container-app-name>];
```

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

```csharp
var sqlDatabaseProject = builder.AddSqlProject<Projects.database>("sql-project")
	.WithReference(sqlDatabase);

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)
	.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, 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
```

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.
- Aspire shows SQL Server, DAB, SQL Commander, and MCP Inspector healthy.
- 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.
- REST, GraphQL, and MCP return seeded data anonymously.
- 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.
- In Azure, the DAB Container App has a system-assigned managed identity.
- In Azure, the connection string contains `Authentication=Active Directory Default` and contains no `User ID=` or `Password=`.
- The DAB managed identity exists as a contained database user with `db_datareader` and `db_datawriter`.

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.

相關內容

  • Last updated on