Szybki start: używanie zabezpieczeń na poziomie wiersza SQL za pomocą konstruktora interfejsu API danych

W tym przewodniku Szybki start użyjesz przykładu Quickstart 5 Row-Level Security, aby wymusić izolację danych dla poszczególnych użytkowników w programie SQL Server. Aplikacja internetowa loguje użytkowników przy użyciu Microsoft Entra ID, wysyła token elementu nośnego do konstruktora interfejsu API danych (DAB), a zabezpieczenia na poziomie wiersza SQL (RLS) filtrują wiersze w warstwie bazy danych.

W przykładzie użyto biblioteki Microsoft Authentication Library (MSAL) w aplikacji jednostronicowej (SPA), roli DAB oraz zabezpieczeń na poziomie wierszy (RLS) w SQL Server z funkcją predykatu i zasadą zabezpieczeń. DAB mapuje oświadczenie uwierzytelnionego użytkownika preferred_username do kontekstu sesji SQL SESSION_CONTEXT, a SQL filtruje wiersze na podstawie tego kontekstu sesji. Przykład nie używa zasad bazy danych DAB dla poszczególnych encji ani niestandardowego kodu API.

Wymagania wstępne

  • .NET 8 lub nowszy
  • Docker Desktop
  • PowerShell
  • Narzędzia .NET Aspire do lokalnej orkiestracji
  • Azure CLI do konfiguracji Microsoft Entra i wdrażania na platformie Azure
  • pakiet sqlpackage w przypadku wdrażania projektu bazy danych
  • Subskrypcja Azure z uprawnieniami do tworzenia Azure SQL, Azure Container Apps, Azure Container Registry, Log Analytics i grupy zasobów
  • Uprawnienie do tworzenia lub ponownego używania rejestracji aplikacji Microsoft Entra

Co pokazano w przykładzie

  • Statyczna aplikacja internetowa korzystająca z logowania przeglądarki MSAL i automatycznego przekierowywania.
  • Rejestracja aplikacji SPA dla aplikacji internetowej oraz rejestracja aplikacji interfejsu API dla DAB.
  • Delegowany zakres uprawnień interfejsu API, o który przeglądarka występuje na potrzeby wywołań DAB.
  • Wywołania z tokenem Bearer z aplikacji internetowej do DAB.
  • DAB skonfigurowany do używania dostawcy uwierzytelniania Microsoft Entra ID EntraId.
  • Uprawnienia encji DAB wykorzystujące rolę authenticated.
  • Zabezpieczenia RLS w SQL Server, które filtrują wiersze na podstawie claimu preferred_username zalogowanego użytkownika.
  • Kontekst sesji DAB, który mapuje deklaracje JSON Web Token (JWT) do SQL SESSION_CONTEXT.
  • Uwierzytelnianie SQL z języka DAB do lokalnego kontenera deweloperskiego SQL Server.
  • Bezhasłowy dostęp usługi DAB do Azure SQL przy użyciu tożsamości zarządzanej przypisanej przez system.
  • Filtrowanie danych poszczególnych użytkowników w języku SQL bez zasad bazy danych dla jednostek DAB.

Przepływ uwierzytelniania

Hop Uwierzytelnianie lokalne Uwierzytelnianie platformy Azure
Użytkownik do aplikacji internetowej Microsoft Entra ID z automatycznym przekierowaniem Microsoft Entra ID z automatycznym przekierowaniem
Aplikacja internetowa do interfejsu API Token elementu nośnego Token elementu nośnego
Rola API authenticated authenticated
Interfejs API do języka SQL Uwierzytelnianie SQL za pomocą SQL RLS Tożsamość zarządzana przypisana przez system z funkcją RLS SQL

Porównanie z serią

Step Co się zmienia
Wstecz Używaj zasad DAB do filtrowania danych dla poszczególnych użytkowników — filtruj wiersze w DAB przy użyciu wyrażeń zasad.
Ten przewodnik Szybki start Przenosi filtrowanie dla każdego użytkownika do mechanizmu SQL RLS przy użyciu kontekstu sesji wypełnianego przez DAB.
Dalej Uwierzytelnianie „on-behalf-of” umożliwia usłudze Azure SQL uwierzytelnianie faktycznie zalogowanego użytkownika.

Zasady zabezpieczeń na poziomie wiersza

SQL Server wymusza dostęp na poziomie wiersza za pomocą funkcji predykatu i zasad zabezpieczeń.

CREATE FUNCTION dbo.UserFilterPredicate(@OwnerId sysname)
RETURNS TABLE WITH SCHEMABINDING AS
RETURN SELECT 1 AS IsVisible
WHERE @OwnerId = CAST(SESSION_CONTEXT(N'preferred_username') AS sysname);

CREATE SECURITY POLICY UserFilterPolicy
ADD FILTER PREDICATE dbo.UserFilterPredicate(Owner) ON dbo.Todos
WITH (STATE = ON);

DAB przesyła uwierzytelnione oświadczenia z tokenu JWT do kontekstu sesji SQL, gdy data-source.options.set-session-context ma wartość true.

{
  "data-source": {
    "database-type": "mssql",
    "connection-string": "@env('MSSQL_CONNECTION_STRING')",
    "options": {
      "set-session-context": true
    }
  }
}

Baza danych zwraca tylko te wiersze, w których kolumna Owner ma wartość SESSION_CONTEXT(N'preferred_username'). DAB może normalnie żądać wierszy; SQL stosuje filtr końcowy.

Important

W tym przykładzie nie są używane zasady bazy danych DAB, takie jak @item.Owner eq @claims.preferred_username. SQL RLS jest właścicielem filtru wiersza.

Korzystanie z przykładu

Sklonuj przykładowe repozytorium.

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

Przywracanie narzędzi lokalnych.

dotnet tool restore

Zaloguj się do Azure.

az login

Uruchom przykład lokalnie.

dotnet run --project aspire-apphost

Podczas pierwszego uruchomienia Aspire sprawdza konfigurację Microsoft Entra. Jeśli brakuje wartości konfiguracji, przykład proponuje interaktywne uruchomienie procesu konfiguracji Microsoft Entra. Skrypt konfiguracji tworzy lub konfiguruje rejestracje aplikacji, aktualizuje web-app/config.js i data-api/dab-config.jsonuruchamia zasoby lokalne.

Aplikacja internetowa przekierowuje użytkowników na stronę logowania firmy Microsoft. Po zalogowaniu wywołania interfejsu API zawierają tokeny okaziciela, DAB mapuje preferred_username do kontekstu sesji SQL, a mechanizm RLS w SQL zwraca tylko dopasowane wiersze.

Wdróż przykład w Azure.

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

Skrypt wdrażania tworzy i konfiguruje zasoby Azure SQL i Azure Container Apps dla DAB, aplikacji internetowej, inspektora MCP (Model Context Protocol) i SQL Commander. Konfiguruje również aplikację kontenerową DAB z przypisaną przez system tożsamością zarządzaną i uruchamia azure-infra/post-provision.ps1 w celu wdrożenia bazy danych, utworzenia użytkownika dla tożsamości zarządzanej, nadania ról bazy danych oraz zweryfikowania konfiguracji RLS.

Wyczyść zasoby platformy Azure i rejestracje aplikacji po zakończeniu.

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

Proces oczyszczania usuwa zasoby platformy Azure i uruchamia skrypt demontażu Microsoft Entra. Jeśli musisz oddzielnie usunąć rejestracje aplikacji, uruchom skrypt usuwania z folderu przykładu azure-infra .

Kluczowe pliki

Path Purpose
data-api/dab-config.json Definiuje dostawcę EntraId , authenticated rolę i set-session-context ustawienie.
database/Functions/UserFilterPredicate.sql Definiuje funkcję predykatu RLS, która porównuje Owner z SESSION_CONTEXT(N'preferred_username').
database/Security/UserFilterPolicy.sql Definiuje UserFilterPolicy politykę zabezpieczeń na dbo.Todos.
web-app/auth.js Konfiguruje bibliotekę MSAL, automatyczne przekierowanie, uzyskiwanie tokenów i akcję wylogowania.
web-app/dab.js Wysyła nagłówki Authorization: Bearer <token> w wywołaniach DAB.
web-app/config.js Przechowuje identyfikator dzierżawy, identyfikator klienta SPA, adres URL interfejsu API i zakres API dla biblioteki MSAL.
azure-infra/post-provision.ps1 Wdraża pakiet dacpac, ustawia administratora Microsoft Entra dla usługi Azure SQL, tworzy użytkownika zarządzanej tożsamości, przyznaje role w bazie danych oraz aktualizuje ustawienia DAB i aplikacji internetowej.

Użyj GitHub Copilot, aby ponownie utworzyć ten przykład

Otwórz obszar roboczy, w którym chcesz utworzyć przykład w Visual Studio Code, przełącz GitHub Copilot do trybu agenta i wklej ten monit.

You are GitHub Copilot running in agent mode. Recreate the Data API builder Quickstart 5 SQL Row-Level Security sample as a complete, runnable project in the current VS Code workspace under `quickstart-05-sql-row-level-security`. Build a static SPA with MSAL browser sign-in, DAB with Microsoft Entra bearer-token validation, SQL Server row-level security (RLS), 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 add DAB per-entity database policies; SQL RLS must enforce row filtering. 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-db_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) NOT NULL` schema, `api://<api-app-id>/access` scope, and `preferred_username` claim-to-session-context mapping 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?

If any artifact uses a different claim key, align all DAB config, SQL predicate, seed data, and validation steps to `preferred_username` and continue. Ask only if the intended claim mapping is ambiguous after inspecting the artifacts.

After the answers, show a checklist and ask for approval before implementation. Include phases for local scaffold, Entra setup, RLS schema, 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, Microsoft Entra validation, and SQL row-level security. 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 init` session context: https://learn.microsoft.com/azure/data-api-builder/command-line/dab-init
- `dab configure` session context: https://learn.microsoft.com/azure/data-api-builder/command-line/dab-configure
- `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`, `entra-setup.ps1`, `entra-teardown.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 with `Functions/UserFilterPredicate.sql`, `Security/UserFilterPolicy.sql`, and 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')" --set-session-context true --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,create,update,delete" --mcp.dml-tools true
dab validate --config data-api/dab-config.json
```

Use this DAB data-source shape. `set-session-context` is required so DAB maps claims into SQL `SESSION_CONTEXT`.

```json
{
  "data-source": {
    "database-type": "mssql",
    "connection-string": "@env('MSSQL_CONNECTION_STRING')",
    "options": { "set-session-context": true }
  }
}
```

Create SQL RLS in the database project. The predicate must use the same claim name DAB sends to `SESSION_CONTEXT`; if any artifact uses a different key, align the artifacts to the approved claim mapping and continue. Ask the user only if the intended claim mapping is ambiguous.

```sql
CREATE FUNCTION dbo.UserFilterPredicate(@OwnerId sysname)
RETURNS TABLE WITH SCHEMABINDING AS
RETURN SELECT 1 AS IsVisible
WHERE @OwnerId = CAST(SESSION_CONTEXT(N'preferred_username') AS sysname);

CREATE SECURITY POLICY UserFilterPolicy
ADD FILTER PREDICATE dbo.UserFilterPredicate(Owner) ON dbo.Todos
WITH (STATE = ON);
```

Do not add `policy.database` filters to DAB entity permissions in this quickstart. SQL RLS is the authoritative filter. Remove the `anonymous` role from protected entities so anonymous REST, GraphQL, and MCP calls to those entities are denied.

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, deploy the dacpac before image validation, 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, contains rows for at least two owners, and has the RLS policy enabled.
- 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 reach DAB under the `authenticated` role.
- DAB sends `preferred_username` into SQL `SESSION_CONTEXT`.
- `SELECT name, is_enabled FROM sys.security_policies` shows `UserFilterPolicy` with `is_enabled = 1`.
- Two different users see different row sets when `Owner` values differ.
- The DAB configuration has `set-session-context` set to `true` and no per-entity database policies.
- MCP Inspector can connect to DAB MCP and respects authenticated access for protected entities.
- SQL Commander opens and shows seeded tables and the enabled RLS policy.
- 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.

Treści powiązane

  • Last updated on