Schnellstart: Hinzufügen eines Microsoft Entra-Anbieters zum Daten-API-Generator

In dieser Schnellstartanleitung verwenden Sie das Beispiel Schnellstart 3: Einrichten von Entra ID, um Data API Builder (DAB) mit einem Microsoft Entra ID-Authentifizierungsanbieter zu konfigurieren. Die Web-App und DAB-Entitäten bleiben anonym, sodass der Browser keine Anmelde-UI, MSAL oder Bearertoken benötigt.

Das Beispiel erstellt eine Microsoft Entra App-Registrierung, konfiguriert den DAB-EntraId-Anbieter mit einer Zielgruppe und einem Issuer und hält die Rolle anonymous aktiv. Mit diesem Muster können Sie eine Tokenüberprüfungsinfrastruktur hinzufügen, bevor Sie sich anmelden müssen.

Voraussetzungen

  • .NET 8 oder höher
  • Docker Desktop
  • PowerShell
  • .NET Aspire tooling für die lokale Orchestrierung
  • Azure CLI für Microsoft Entra Einrichtung und Azure Bereitstellung
  • sqlpackage , wenn Sie das Datenbankprojekt bereitstellen
  • Ein Azure-Abonnement mit der Berechtigung zum Erstellen von Azure SQL, Azure Container Apps, Azure Container Registry, Log Analytics und einer Ressourcengruppe
  • Berechtigung zum Erstellen oder Wiederverwenden einer Microsoft Entra App-Registrierung

Was das Beispiel zeigt

  • Eine statische Web-App, die DAB ohne Benutzeranmeldung aufruft.
  • DAB mit dem EntraId Authentifizierungsanbieter konfiguriert.
  • Eine Microsoft Entra App-Registrierung, die die DAB-API-Zielgruppe und den Aussteller bereitstellt.
  • Entitätsberechtigungen, die die anonymous Rolle aktiv halten.
  • Entitätsberechtigungen, die die authenticated Rolle enthalten, damit DAB gültige Bearertoken akzeptieren kann.
  • SQL-Authentifizierung von DAB zum lokalen SQL Server Entwicklungscontainer.
  • Kennwortloser DAB-Zugriff auf Azure SQL über eine vom System zugewiesene verwaltete Identität.
  • .NET Aspire Orchestrierung für lokale SQL Server, DAB, die Web-App, SQL Commander und MCP Inspector.
  • Bereitstellung und Bereinigung von Azure über PowerShell-Skripte in azure-infra.

Authentifizierungsfluss

Hop Lokale Authentifizierung Azure-Authentifizierung
Benutzer zur Web-App Anonym Anonym
Web-App zu API Anonym Anonym
API-Authentifizierungsanbieter EntraId, mit anonymen Entitäten EntraId, mit anonymen Entitäten
API für SQL SQL-Authentifizierung Vom System zugewiesene verwaltete Identität

Wichtig

Die DAB-API überprüft Microsoft Entra Token, anonyme Entitätsberechtigungen lassen jedoch weiterhin nicht authentifizierte Anforderungen zu. Fügen Sie strengere Berechtigungen nur hinzu, wenn die Web-App Bearertoken sendet.

Vergleichen mit der Datenreihe

Step Was ändert sich?
Zurück Use managed identity entfernt das Azure SQL Kennwort, lässt die Web-App und die API jedoch anonym.
Diese Schnellstartanleitung Fügt einen Microsoft Entra Anbieter, eine Zielgruppe und einen Aussteller hinzu, während der anonyme Zugriff aktiv bleibt.
Weiter Die Verwendung von DAB-Richtlinien für benutzerspezifische Daten erfordert eine Anmeldung und filtert Zeilen mithilfe von DAB-Richtlinienausdrücken.

Verwenden Sie das Beispiel

Klonen Sie das Beispiel-Repository.

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

Stellen Sie lokale Tools wieder her.

dotnet tool restore

Melden Sie sich bei Azure an.

az login

Führen Sie das Beispiel lokal aus.

dotnet run --project aspire-apphost

Beim ersten Ausführen überprüft Aspire dab-config.json auf Microsoft-Entra-Platzhalter. Wenn der Anbieter nicht konfiguriert ist, bietet die App an, azure-infra/entra-setup.ps1 interaktiv auszuführen. Das Skript erstellt oder konfiguriert die App-Registrierung, aktualisiert die Zielgruppe und den Aussteller und startet dann die lokalen Ressourcen.

Die Web-App wird anonym geladen. DAB hat den EntraId Anbieter hinter den Kulissen konfiguriert.

Stellen Sie das Beispiel für Azure bereit.

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

Das Bereitstellungsskript stellt Azure SQL und Azure Container Apps Ressourcen für DAB, web app, MCP Inspector und SQL Commander bereit. Außerdem wird für die DAB-Container-App eine systemseitig zugewiesene verwaltete Identität konfiguriert und die Zielgruppe und der Aussteller von Microsoft Entra an DAB übergeben.

Bereinigen Sie Azure Ressourcen und die App-Registrierung, wenn Sie fertig sind.

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

Der Bereinigungsfluss führt das Microsoft Entra Teardown-Skript aus. Wenn Sie die App-Registrierung separat entfernen müssen, führen Sie azure-infra/entra-teardown.ps1 aus dem Beispiel aus.

Schlüsseldateien

Pfad Purpose
data-api/dab-config.json Definiert den EntraId Authentifizierungsanbieter, die Zielgruppe, den Herausgeber und die Entitätsrollen.
aspire-apphost/Demo.cs Sucht in dab-config.json nach Platzhaltern für Microsoft Entra und leitet durch die lokale Einrichtung.
azure-infra/entra-setup.ps1 Erstellt oder konfiguriert die App-Registrierung und die API-Zielgruppe.
azure-infra/entra-teardown.ps1 Löscht die App-Registrierung während des Abbruchs.
web-app/index.html, web-app/app.js, web-app/dab.js, web-app/config.js Statische Webdateien, die anonym bleiben und MSAL nicht verwenden.

Verwenden von GitHub Copilot, um dieses Beispiel neu zu erstellen

Öffnen Sie den Arbeitsbereich, in dem Sie das Beispiel in Visual Studio Code erstellen möchten, wechseln Sie GitHub Copilot zum Agentmodus, und fügen Sie diese Eingabeaufforderung ein.

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.

Verwandte Inhalte

  • Last updated on