Schnellstart: Verwenden Sie Richtlinien für Data API Builder für benutzerspezifische Daten

In dieser Schnellstartanleitung verwenden Sie das Beispiel Quickstart 4 Benutzerauthentifizierung mit DAB-Richtlinien zum Filtern von Daten pro angemeldeten Benutzer. Die Web-App meldet benutzer mit Microsoft Entra ID an, sendet ein Bearertoken an den Daten-API-Generator (DAB), und DAB wendet eine Datenbankrichtlinie an, bevor SQL-Zeilen zurückgegeben werden.

Das Beispiel verwendet die Microsoft Authentication Library (MSAL) (MSAL) in einer Single-Page-Anwendung (SPA), die DAB-authenticated-Rolle und den Richtlinienausdruck @item.Owner eq @claims.preferred_username. Im Beispiel wird kein geheimer Clientschlüssel oder benutzerdefinierter API-Code verwendet.

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 Microsoft Entra App-Registrierungen

Was das Beispiel zeigt

  • Eine statische Web-App, die die Anmeldung über den MSAL-Browser und die automatische Weiterleitung verwendet.
  • Eine SPA-App-Registrierung für die Web-App und eine API-App-Registrierung für DAB.
  • Ein delegierter API-Bereich, den der Browser für DAB-Aufrufe anfordert.
  • Bearer-Token-Aufrufe von der Web-App an DAB.
  • DAB mit dem Microsoft Entra ID EntraId-Authentifizierungsanbieter konfiguriert.
  • DAB-Entitätsberechtigungen, die die authenticated Rolle verwenden.
  • Eine DAB-Datenbankrichtlinie, die Zeilen nach dem Anspruch des angemeldeten Benutzers filtert.
  • SQL-Authentifizierung von DAB zum lokalen SQL Server Entwicklungscontainer.
  • Kennwortloser DAB-Zugriff auf Azure SQL über eine vom System zugewiesene verwaltete Identität.
  • Benutzerspezifische Datenfilterung in DAB ohne benutzerdefinierten API-Code oder einen geheimen Clientschlüssel.

Authentifizierungsfluss

Hop Lokale Authentifizierung Azure-Authentifizierung
Benutzer zur Web-App Microsoft Entra ID mit automatischer Umleitung Microsoft Entra ID mit automatischer Umleitung
Web-App zu API Bearertoken Bearertoken
API-Rolle authenticated authenticated
API für SQL SQL-Authentifizierung mit DAB-Richtlinie Vom System zugewiesene verwaltete Identität mit DAB-Richtlinie

Vergleichen mit der Datenreihe

Step Was ändert sich?
Zurück Hinzufügen eines Microsoft Entra-Anbieters überprüft Token, lässt aber weiterhin anonymen Zugriff auf Entitäten zu.
Diese Schnellstartanleitung Erfordert eine Anmeldung mit MSAL, sendet Bearer-Token an DAB und filtert Zeilen mithilfe einer Datenbankrichtlinie in DAB.
Weiter Verwenden Sie die Sicherheit auf SQL-Zeilenebene , um die Benutzerfilterung von DAB in SQL zu verschieben.

Policy

DAB wendet diese Datenbankrichtlinie auf geschützte Entitätsaktionen an.

@item.Owner eq @claims.preferred_username

Mit der Richtlinie kann ein angemeldeter Benutzer nur auf Zeilen zugreifen, in denen die Owner Spalte dem Anspruch des preferred_username Benutzers entspricht. Entfernen Sie die anonymous Rolle aus geschützten Entitäten, sodass anonyme Anforderungen an REST und GraphQL zurückgegeben werden 401.

{
  "entities": {
    "Todos": {
      "permissions": [
        {
          "role": "authenticated",
          "actions": [
            {
              "action": "read",
              "policy": {
                "database": "@item.Owner eq @claims.preferred_username"
              }
            },
            {
              "action": "update",
              "policy": {
                "database": "@item.Owner eq @claims.preferred_username"
              }
            },
            {
              "action": "delete",
              "policy": {
                "database": "@item.Owner eq @claims.preferred_username"
              }
            }
          ]
        }
      ]
    }
  }
}

Verwenden Sie das Beispiel

Klonen Sie das Beispiel-Repository.

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

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

Bei der ersten Ausführung überprüft Aspire die Microsoft Entra Konfiguration. Wenn Konfigurationswerte fehlen, bietet das Beispiel die interaktive Ausführung azure-infra/entra-setup.ps1 an. Das Setupskript erstellt oder konfiguriert die App-Registrierungen, aktualisiert web-app/config.js und data-api/dab-config.json und startet die lokalen Ressourcen.

Die Web-App leitet Benutzer zur Microsoft-Anmeldung weiter. Nach der Anmeldung enthalten API-Aufrufe Bearertoken, und jeder Benutzer sieht nur Zeilen, die ihrem preferred_username Anspruch entsprechen.

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, Model Context Protocol (MCP) Inspector und SQL Commander bereit. Außerdem wird die DAB-Container-App mit einer vom System zugewiesenen verwalteten Identität konfiguriert und Microsoft Entra Setup während der Bereitstellung ausgeführt.

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

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

Der Bereinigungsfluss führt das Microsoft Entra Teardown-Skript aus. Wenn Sie die App-Registrierungen 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 die EntraId Anbieter-, authenticated Rollen- und Datenbankrichtlinie.
web-app/auth.js Konfiguriert MSAL, automatische Umleitung, Tokenakquisition und die Abmeldeaktion.
web-app/index.html Lädt die MSAL-Browserunterstützung und zeigt authentifizierte UI-Elemente an.
web-app/app.js Initialisiert die App nach der Authentifizierung und aktualisiert den angemeldeten Zustand.
web-app/dab.js Sendet Authorization: Bearer <token> Kopfzeilen mit DAB-Aufrufen.
web-app/config.js Speichert die Mandanten-ID, die SPA-Client-ID und den API-Bereich für MSAL.

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 4 User Authentication with DAB Policies sample as a complete, runnable project in the current VS Code workspace under `quickstart-04-dab-policies`. Build a static SPA with MSAL browser sign-in, DAB with Microsoft Entra bearer-token validation, a DAB database policy for per-user rows, 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. DAB is the only API, GraphQL, and MCP layer over SQL. Do not create custom API code. Do not create or use a client secret for this quickstart.

Source repository: https://github.com/Azure-Samples/dab-2.0-quickstart-web_entra-api_entra-db_entra-api_rls. 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 `Owner nvarchar(256)` schema, `@claims.preferred_username` policy, and `api://<api-app-id>/access` scope unless the user explicitly asks for different values. 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 new app registrations for the SPA and API or reuse existing registrations?
- Do you approve creating billable Azure resources and Microsoft Entra app registrations if deployment 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`, `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 add` policies: 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 rows for at least two owners.
- `web-app/` for static HTML, CSS, and JavaScript with MSAL browser support.
- `aspire-apphost/` for the .NET Aspire AppHost.
- `mcp-inspector/` for MCP Inspector notes or container assets.

Handle generated values first. Add `.env`, `**/bin`, and `**/obj` to `.gitignore` before writing secrets or local configuration. Use `MSSQL_CONNECTION_STRING`, `ENTRA_TENANT_ID`, `ENTRA_AUDIENCE`, `ENTRA_ISSUER`, `SPA_CLIENT_ID`, and `API_SCOPE`. 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` because this SPA sends bearer tokens, not 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 and validate after each config change:

```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 "authenticated:read,update,delete" --policy-database "@item.Owner eq @claims.preferred_username" --mcp.dml-tools true
dab validate --config data-api/dab-config.json
```

Use this DAB policy shape if you write the config directly. Remove the `anonymous` role from protected entities so anonymous REST, GraphQL, and MCP calls to those entities are denied.

```json
{
  "role": "authenticated",
  "actions": [
    { "action": "read", "policy": { "database": "@item.Owner eq @claims.preferred_username" } },
    { "action": "update", "policy": { "database": "@item.Owner eq @claims.preferred_username" } },
    { "action": "delete", "policy": { "database": "@item.Owner eq @claims.preferred_username" } }
  ]
}
```

Implement the SPA with MSAL browser. `web-app/dab.js` must send bearer tokens to DAB on every protected request.

```javascript
export async function getAuthHeaders() {
  const token = await acquireAccessToken();
  return { Authorization: `Bearer ${token}` };
}
```

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 bake `dab-config.json` into the DAB image. Replace web URL and CORS placeholders before image build. Do not rely on volume mounts in Azure Container Apps.

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 for at least two owners.
- DAB `/health` returns a 2xx response.
- The web site returns a successful HTTP response.
- A browser-origin request from each web app origin receives an `Access-Control-Allow-Origin` response header that matches that origin.
- Anonymous REST and GraphQL requests to protected entities return `401`.
- Signed-in REST and GraphQL calls include bearer headers and return only rows where `Owner` equals the selected claim.
- Two different users see disjoint row sets.
- The DAB configuration uses the `authenticated` role with DAB database policies and no client secret.
- MCP Inspector can connect to DAB MCP and respects authenticated access for protected entities.
- SQL Commander opens and shows seeded tables for at least two owners.
- In Azure, the DAB Container App has a system-assigned managed identity and Container Apps are healthy.

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