Mulai cepat: Menggunakan kebijakan penyusun API Data untuk data per pengguna

Dalam panduan mulai cepat ini, Anda menggunakan Sampel Mulai Cepat 4: Autentikasi Pengguna dengan Kebijakan DAB untuk memfilter data berdasarkan pengguna yang telah masuk. Aplikasi web memungkinkan pengguna masuk dengan Microsoft Entra ID, mengirim token bearer ke Data API builder (DAB), dan DAB menerapkan kebijakan basis data sebelum mengembalikan baris data SQL.

Contoh ini menggunakan Pustaka Autentikasi Microsoft (MSAL) pada aplikasi satu halaman (SPA), peran DAB authenticated, dan ekspresi kebijakan @item.Owner eq @claims.preferred_username. Sampel tidak menggunakan rahasia klien atau kode API kustom.

Prasyarat

Apa yang ditunjukkan sampel

  • Aplikasi web statis yang menggunakan proses masuk melalui browser dengan MSAL dan pengalihan otomatis.
  • Pendaftaran aplikasi SPA untuk aplikasi web dan pendaftaran aplikasi API untuk DAB.
  • Cakupan API yang didelegasikan yang diminta browser untuk panggilan DAB.
  • Panggilan token pembawa dari aplikasi web ke DAB.
  • DAB dikonfigurasi dengan penyedia autentikasi Microsoft Entra ID EntraId.
  • Izin entitas DAB yang menggunakan peran authenticated.
  • Kebijakan database DAB yang memfilter baris menurut klaim pengguna yang masuk.
  • Autentikasi SQL dari DAB ke kontainer pengembangan SQL Server lokal.
  • Akses DAB tanpa kata sandi ke Azure SQL melalui identitas terkelola yang ditetapkan sistem.
  • Pemfilteran data per pengguna di DAB tanpa kode API kustom atau rahasia klien.

Proses autentikasi

Lompatan Otentikasi lokal. Autentikasi Azure
Pengguna ke aplikasi web Microsoft Entra ID dengan pengalihan otomatis Microsoft Entra ID dengan pengalihan otomatis
Aplikasi web ke API Token pembawa Token pembawa
Peran API authenticated authenticated
API ke SQL Autentikasi SQL dengan kebijakan DAB Identitas terkelola yang ditetapkan oleh sistem dengan kebijakan DAB

Bandingkan dengan seri

Step Perubahan apa
Previous Tambahkan penyedia Microsoft Entra memvalidasi token tetapi masih memungkinkan akses entitas anonim.
Mulai cepat ini Memerlukan proses masuk dengan MSAL, mengirim token bearer ke DAB, dan memfilter baris menggunakan kebijakan database DAB.
Berikutnya Gunakan keamanan tingkat baris SQL memindahkan pemfilteran per pengguna dari DAB ke SQL.

Policy

DAB menerapkan kebijakan database ini ke tindakan entitas yang dilindungi.

@item.Owner eq @claims.preferred_username

Kebijakan ini memungkinkan pengguna yang telah masuk untuk mengakses hanya baris yang nilai pada kolom Owner sesuai dengan klaim preferred_username milik pengguna. Hapus peran anonymous dari entitas yang dilindungi sehingga permintaan anonim ke REST dan GraphQL mengembalikan 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"
              }
            }
          ]
        }
      ]
    }
  }
}

Menggunakan sampel

Kloning repositori sampel.

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

Pulihkan alat lokal.

dotnet tool restore

Masuk ke Azure.

az login

Jalankan sampel secara lokal.

dotnet run --project aspire-apphost

Pada eksekusi pertama, Aspire memeriksa konfigurasi Microsoft Entra. Jika nilai konfigurasi tidak ada, contoh tersebut menawarkan opsi untuk menjalankan azure-infra/entra-setup.ps1 secara interaktif. Skrip penyiapan membuat atau mengonfigurasi pendaftaran aplikasi, pembaruan web-app/config.js , dan data-api/dab-config.json, dan memulai sumber daya lokal.

Aplikasi web mengalihkan pengguna ke halaman masuk Microsoft. Setelah masuk, panggilan API menyertakan token pembawa, dan setiap pengguna hanya melihat baris yang cocok dengan klaim mereka preferred_username .

Sebarkan sampel ke Azure.

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

Skrip penyebaran menyediakan sumber daya Azure SQL dan Azure Container Apps untuk DAB, aplikasi web, Pemeriksa Protokol Konteks Model (MCP), dan Komandan SQL. Ini juga mengonfigurasi aplikasi kontainer DAB dengan identitas terkelola yang ditetapkan oleh sistem dan melakukan penyiapan Microsoft Entra selama penyebaran.

Bersihkan Azure sumber daya dan pendaftaran aplikasi setelah Selesai.

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

Alur pembersihan menjalankan skrip pembongkaran Microsoft Entra. Jika Anda perlu menghapus pendaftaran aplikasi secara terpisah, jalankan azure-infra/entra-teardown.ps1 dari sampel.

File utama

Jalur Kegunaan
data-api/dab-config.json EntraId Menentukan penyedia, authenticated peran, dan kebijakan database.
web-app/auth.js Mengonfigurasi MSAL, pengalihan otomatis, perolehan token, dan tindakan keluar dari akun.
web-app/index.html Memuat dukungan browser MSAL dan menunjukkan elemen UI yang diautentikasi.
web-app/app.js Menginisialisasi aplikasi setelah autentikasi dan memperbarui status masuk.
web-app/dab.js Mengirim Authorization: Bearer <token> header dengan pemanggilan DAB.
web-app/config.js Menyimpan ID penyewa, ID klien SPA, dan cakupan API untuk MSAL.

Gunakan GitHub Copilot untuk membuat ulang sampel ini

Buka ruang kerja tempat Anda ingin membuat sampel di Visual Studio Code, beralih GitHub Copilot ke mode agen, dan tempelkan perintah ini.

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.

Konten terkait

  • Last updated on