Snelstart: Beleidsregels voor Data API Builder gebruiken voor gegevens per gebruiker

In deze quickstart gebruikt u de Quickstart 4-gebruikersverificatie met voorbeeld dab-beleid om gegevens per aangemelde gebruiker te filteren. De web-app meldt gebruikers aan met Microsoft Entra ID, verzendt een bearer-token naar Data API Builder (DAB) en DAB past een databasebeleid toe voordat SQL-rijen worden geretourneerd.

In het voorbeeld wordt de Microsoft Authentication Library (MSAL) gebruikt in een toepassing met één pagina (SPA), de DAB-authenticated-rol en de beleidsexpressie @item.Owner eq @claims.preferred_username. In het voorbeeld wordt geen clientgeheim of aangepaste API-code gebruikt.

Prerequisites

  • .NET 8 of hoger
  • Docker Desktop
  • PowerShell
  • .NET Aspire tooling voor lokale orchestratie
  • Azure CLI voor Microsoft Entra installatie en Azure implementatie
  • sqlpackage als u het databaseproject implementeert
  • Een Azure-abonnement met machtigingen voor het maken van Azure SQL, Azure Container Apps, Azure Container Registry, Log Analytics en een resourcegroep
  • Machtiging om Microsoft Entra app-registraties te maken of opnieuw te gebruiken

Wat het voorbeeld laat zien

  • Een statische web-app die gebruikmaakt van msal-browser-aanmelding en automatische omleiding.
  • Een SPA-app-registratie voor de web-app en een API-app-registratie voor DAB.
  • Een gedelegeerd API-bereik dat door de browser wordt aangevraagd voor DAB-aanroepen.
  • Aanroepen met bearertoken van de web-app naar DAB.
  • DAB geconfigureerd met de Microsoft Entra ID EntraId-verificatieprovider.
  • DAB-entiteitsmachtigingen die gebruikmaken van de authenticated rol.
  • Een DAB-databasebeleid waarmee rijen worden gefilterd op basis van de claim van de aangemelde gebruiker.
  • SQL-verificatie van DAB naar de lokale SQL Server ontwikkelcontainer.
  • DAB-toegang zonder wachtwoord tot Azure SQL via een door het systeem toegewezen beheerde identiteit.
  • Filteren van gegevens per gebruiker in DAB zonder aangepaste API-code of een clientgeheim.

Authenticatiestroom

Hop Lokale verificatie Azure-verificatie
Van gebruiker naar webapp Microsoft Entra ID met automatische omleiding Microsoft Entra ID met automatische omleiding
Web-app naar API draagtoken draagtoken
API-functie authenticated authenticated
van API naar SQL SQL-verificatie met DAB-beleid Door het systeem toegewezen beheerde identiteit met DAB-beleid

Vergelijken met de reeks

Step Welke wijzigingen
Previous Add a Microsoft Entra provider valideert tokens, maar staat anonieme entiteitstoegang toe.
Deze snelstartgids Vereist MSAL-aanmelding, verzendt bearer-tokens naar DAB en filtert rijen met een DAB-databasebeleid.
Volgende Met beveiliging op rijniveau van SQL worden filters per gebruiker van DAB naar SQL verplaatst.

Policy

DAB past dit databasebeleid toe op acties voor beveiligde entiteiten.

@item.Owner eq @claims.preferred_username

Met dit beleid heeft een aangemelde gebruiker alleen toegang tot rijen waarvoor de waarde in de kolom Owner overeenkomt met de claim preferred_username van de gebruiker. Verwijder de anonymous rol uit beveiligde entiteiten, zodat anonieme aanvragen voor REST en GraphQL worden geretourneerd 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"
              }
            }
          ]
        }
      ]
    }
  }
}

Het voorbeeld gebruiken

Kloon de voorbeeldopslagplaats.

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

Lokale hulpmiddelen herstellen.

dotnet tool restore

Meld u aan bij Azure.

az login

Voer het voorbeeld lokaal uit.

dotnet run --project aspire-apphost

Bij de eerste uitvoering controleert Aspire de Microsoft Entra configuratie. Als er configuratiewaarden ontbreken, kan het voorbeeld interactief worden uitgevoerd azure-infra/entra-setup.ps1 . Het installatiescript maakt of configureert de app-registraties, updates web-app/config.js en data-api/dab-config.json, en start de lokale resources.

De web-app leidt gebruikers om naar Microsoft aanmelding. Na aanmelding bevatten API-aanroepen Bearer-tokens en ziet elke gebruiker alleen rijen die overeenkomen met hun preferred_username claim.

Implementeer het voorbeeld in Azure.

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

Het implementatiescript richt Azure SQL en Azure Container Apps resources voor DAB, de web-app, MCP Inspector (Model Context Protocol) en SQL Commander in. Ook wordt de DAB-container-app geconfigureerd met een door het systeem toegewezen beheerde identiteit en wordt de configuratie van Microsoft Entra tijdens de implementatie uitgevoerd.

Ruim Azure-resources en app-registraties op wanneer u klaar bent.

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

Het opschoonproces voert het Microsoft Entra teardown-script uit. Als u de app-registraties afzonderlijk wilt verwijderen, voert u azure-infra/entra-teardown.ps1 uit vanuit het voorbeeld.

Belangrijke bestanden

Pad Purpose
data-api/dab-config.json Hiermee definieert u het EntraId provider-, authenticated rol- en databasebeleid.
web-app/auth.js Hiermee configureert u MSAL, automatische omleiding, tokenverwerving en de afmeldingsactie.
web-app/index.html Hiermee wordt MSAL-browserondersteuning geladen en worden geverifieerde UI-elementen weergegeven.
web-app/app.js Initialiseert de app na verificatie en werkt de status Aangemeld bij.
web-app/dab.js Verzendt Authorization: Bearer <token>-headers met DAB-aanroepen.
web-app/config.js Slaat de tenant-ID, de SPA-client-ID en de API-scope voor MSAL op.

Gebruik GitHub Copilot om dit voorbeeld opnieuw te maken

Open de werkruimte waarin u het voorbeeld wilt maken in Visual Studio Code, schakel GitHub Copilot over naar de agentmodus en plak deze prompt.

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.

Verwante inhoud

  • Last updated on