Snabbstart: Använda hanterad identitet med Data API Builder

I den här snabbstarten använder du exemplet Quickstart 2 Managed Identity för att köra Data API Builder (DAB) med lösenordsfri åtkomst till Azure SQL. Exemplet använder anonym åtkomst från användaren till webbappen, anonym åtkomst från webbappen till DAB och en systemtilldelad hanterad identitet från DAB till Azure SQL.

Exemplet exponerar SQL-data via REST, GraphQL och MCP. Den innehåller även .NET Aspire lokala orkestrerings- och Azure distributionsskript.

Viktigt!

Den lokala vägen kan använda SQL-autentisering som en reservlösning vid utveckling. Den Azure sökvägen använder hanterad identitet och har inget SQL-lösenord i DAB-konfigurationen.

Förutsättningar

  • .NET 8 eller senare
  • Docker Desktop
  • PowerShell
  • .NET Aspire verktyg för lokal orkestrering
  • Azure CLI för Azure distribution
  • sqlpackage om du distribuerar databasprojektet
  • En Azure-prenumeration med behörighet att skapa Azure SQL, Azure Container Apps, Azure Container Registry, Log Analytics och en resursgrupp
  • En Microsoft Entra användare eller grupp som kan bli Azure SQL Microsoft Entra administratör

Vad exemplet visar

  • En statisk webbapp som anropar DAB utan användarinloggning.
  • DAB har konfigurerats som det enda API-, GraphQL- och MCP-lagret över SQL.
  • SQL-autentisering från DAB till den lokala SQL Server utvecklingscontainern.
  • Lösenordslös DAB-åtkomst till Azure SQL via en systemtilldelad hanterad identitet.
  • Azure SQL konfigurerat med en Microsoft Entra administratör.
  • En databasanvändare i en innesluten databas skapad för DAB:s hanterade identitet.
  • db_datareader och db_datawriter rolltilldelningar för DAB-identiteten.
  • .NET Aspire orchestrering för lokal SQL Server, DAB, webbappen, SQL Commander och MCP Inspector.
  • Azure-driftsättning och rensning med PowerShell-skript i azure-infra.

Autentiseringsflöde

Hoppa Lokal autentisering Azure-autentisering
Användare till webbapp Anonym Anonym
Webbapp till API Anonym Anonym
API till SQL SQL-autentisering Systemtilldelad hanterad identitet

Jämför med serien

Step Vilka ändringar
Previous Använd SQL-autentisering lagrar en SQL-autentiseringsuppgift för DAB-till-SQL-åtkomst.
Den här snabbstarten Tar bort Azure SQL lösenord med hjälp av en systemtilldelad hanterad identitet.
Nästa Lägg till en Microsoft Entra-provider konfigurerar tokenvalidering samtidigt som anonym API-åtkomst behålls.

Använd exemplet

Klona exempellagringsplatsen.

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

Kör exemplet lokalt.

dotnet tool restore
dotnet run --project aspire-apphost

Aspire-instrumentpanelen öppnas på http://localhost:15888. Webbappen öppnas på http://localhost:5173. Använd instrumentpanelen för att inspektera DAB-slutpunkten, SQL Server container, MCP Inspector och SQL Commander-resurser.

Distribuera exemplet till Azure.

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

Distributionsskriptet etablerar Azure SQL och Azure Container Apps resurser för DAB, webbappen, MCP Inspector och SQL Commander. Den anger också att DAB-containerappen ska använda en systemtilldelad hanterad identitet och konfigurerar en lösenordslös Azure SQL reťazec pripojenia formad som det här exemplet.

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

Skriptet som körs efter etableringen anger Microsoft Entra-administratören för Azure SQL, skapar en innesluten databasanvändare för den hanterade identiteten för DAB och ger db_datareader och db_datawriter.

Rensa Azure resurser när du är klar.

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

Nyckelfiler

Sökväg Purpose
azure-infra/resources.bicep Definierar Azure-resurser, aktiverar SystemAssigned-identitet på DAB-containerappen och anger den lösenordslösa anslutningssträngen för Azure SQL.
azure-infra/main.bicep Orkestrerar distributionen och returnerar principal-ID:t för DAB Container App.
azure-infra/post-provision.ps1 Anger Microsoft Entra-administratören för Azure SQL, skapar den inneslutna databasanvändaren för DAB-identiteten och tilldelar databasroller.
data-api/dab-config.json DAB-körningskonfiguration för SQL, REST, GraphQL, MCP och anonym entitetsåtkomst.
database SQL Database-projekt, schemafiler och seed-dataskript.
web-app Statisk webbapp som anropar DAB anonymt.
aspire-apphost .NET Aspire AppHost som samordnar lokala containrar och projektresurser.

Använd GitHub Copilot för att återskapa det här exemplet

Öppna arbetsytan där du vill skapa exemplet i Visual Studio Code, växla GitHub Copilot till agentläge och klistra in den här uppmaningen.

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.

Relaterat innehåll

  • Last updated on