Démarrage rapide : Utiliser la sécurité au niveau des lignes SQL avec le générateur d’API de données

Dans ce guide de démarrage rapide, vous utilisez l’exemple Quickstart 5 : sécurité au niveau des lignes pour imposer l’isolation des données pour chaque utilisateur dans SQL Server. L’application web connecte les utilisateurs avec Microsoft Entra ID, envoie un jeton d’accès Bearer à Data API builder (DAB), et la sécurité SQL au niveau des lignes (RLS) filtre les lignes au niveau de la base de données.

L’exemple utilise la bibliothèque d’authentification Microsoft (MSAL) dans une application monopage (SPA), le rôle DAB authenticated et la sécurité au niveau des lignes (RLS) de SQL Server avec une fonction de prédicat et une stratégie de sécurité. DAB associe la revendication preferred_username de l’utilisateur authentifié à SQL SESSION_CONTEXT, et SQL filtre les lignes en fonction de ce contexte de session. L’exemple n’utilise pas les stratégies de base de données DAB par entité ou le code d’API personnalisé.

Prerequisites

  • .NET 8 ou version ultérieure
  • Docker Desktop
  • Powershell
  • outils .NET Aspire pour l’orchestration locale
  • Azure CLI pour le déploiement de Microsoft Entra et de Azure
  • sqlpackage si vous déployez le projet de base de données
  • Un abonnement Azure avec l’autorisation de créer des Azure SQL, des Azure Container Apps, des Azure Container Registry, des Log Analytics et un groupe de ressources
  • Autorisation de créer ou de réutiliser des inscriptions d’applications Microsoft Entra

Présentation de l’exemple

  • Application web statique qui utilise la connexion au navigateur MSAL et la redirection automatique.
  • Inscription d’application SPA pour l’application web et inscription d’application API pour DAB.
  • Étendue d’API déléguée que le navigateur demande pour les appels DAB.
  • Appels avec jeton Bearer de l’application web vers DAB.
  • DAB configuré avec le fournisseur d’authentification Microsoft Entra ID EntraId.
  • Autorisations des entités DAB qui utilisent le rôle authenticated.
  • SQL Server RLS qui filtre les lignes en fonction de la revendication preferred_username de l’utilisateur connecté.
  • Contexte de session DAB qui mappe les revendications JSON Web Token (JWT) en SQL SESSION_CONTEXT.
  • Authentification SQL de DAB vers le conteneur de développement SQL Server local.
  • Accès DAB sans mot de passe à Azure SQL via une identité managée affectée par le système.
  • Filtrage des données par utilisateur dans SQL sans stratégies de base de données DAB par entité.

Flux d’authentification

Hop Authentification locale Authentification d'Azure
Utilisateur vers l’application web Microsoft Entra ID avec redirection automatique Microsoft Entra ID avec redirection automatique
Application web vers l’API Jeton porteur Jeton porteur
Rôle d’API authenticated authenticated
API vers SQL Authentification SQL avec sql RLS Identité managée attribuée par le système avec SQL RLS

Comparer avec la série

Step Modifications apportées
Previous Utilisez des stratégies DAB pour les données par utilisateur filtre les lignes dans DAB à l’aide d’expressions de stratégie.
Ce guide de démarrage rapide Déplace le filtrage par utilisateur au niveau de la RLS SQL à l’aide du contexte de session renseigné par DAB.
Suivant L’authentification de type on-behalf-of permet à Azure SQL d’authentifier l’utilisateur réellement connecté.

Stratégie RLS

SQL Server applique l’accès au niveau des lignes avec une fonction de prédicat et une stratégie de sécurité.

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 envoie des claims JWT authentifiés dans le contexte de session SQL lorsque data-source.options.set-session-context est true.

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

La base de données retourne uniquement les lignes où la Owner colonne correspond SESSION_CONTEXT(N'preferred_username'). DAB peut demander des lignes normalement ; SQL applique le filtre final.

Important

Cet exemple n’utilise pas de stratégies de base de données DAB telles que @item.Owner eq @claims.preferred_username. SQL RLS possède le filtre de ligne.

Utiliser l’exemple

Clonez l’exemple de référentiel.

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

Restaurer les outils locaux.

dotnet tool restore

Connectez-vous à Azure.

az login

Exécutez l’exemple localement.

dotnet run --project aspire-apphost

Lors de la première exécution, Aspire vérifie la configuration Microsoft Entra. Si des valeurs de configuration sont manquantes, l’exemple propose d’exécuter le flux d’installation Microsoft Entra de manière interactive. Le script d’installation crée ou configure les enregistrements d’application, met à jour web-app/config.js et data-api/dab-config.json, et démarre les ressources locales.

L’application web redirige les utilisateurs vers la page de connexion Microsoft. Après la connexion, les appels API incluent des jetons Bearer, DAB mappe preferred_username au contexte de session SQL, et SQL RLS ne renvoie que les lignes correspondantes.

Déployez l’exemple sur Azure.

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

Le script de déploiement provisionne des ressources Azure SQL et Azure Container Apps pour DAB, l’application web, l’inspecteur MCP (Model Context Protocol) et SQL Commander. Il configure également l’application conteneur DAB avec une identité managée affectée par le système et exécute azure-infra/post-provision.ps1 pour déployer la base de données, créer l’utilisateur de l’identité managée, attribuer des rôles de base de données et vérifier la configuration de la sécurité au niveau des lignes (RLS).

Nettoyez les ressources Azure et les enregistrements d’applications une fois que vous avez terminé.

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

Le processus de nettoyage supprime les ressources Azure et exécute le script de suppression de Microsoft Entra. Si vous devez supprimer séparément les enregistrements d’application, exécutez le script de suppression depuis le dossier azure-infra de l’exemple.

Fichiers clés

Chemin Purpose
data-api/dab-config.json Définit le EntraId fournisseur, le authenticated rôle et le set-session-context paramètre.
database/Functions/UserFilterPredicate.sql Définit la fonction de prédicat RLS qui compare Owner à SESSION_CONTEXT(N'preferred_username').
database/Security/UserFilterPolicy.sql Définit la UserFilterPolicy stratégie de sécurité sur dbo.Todos.
web-app/auth.js Configure MSAL, la redirection automatique, l’acquisition de jetons et l’action de déconnexion.
web-app/dab.js Envoie Authorization: Bearer <token> des en-têtes avec des appels DAB.
web-app/config.js Stocke l’ID de locataire, l’ID client SPA, l’URL de l’API et l’étendue de l’API pour MSAL.
azure-infra/post-provision.ps1 Déploie le dacpac, définit l’administrateur Azure SQL Microsoft Entra, crée l’utilisateur d’identité managée, accorde des rôles de base de données et met à jour les paramètres DAB et d’application web.

Utilisez GitHub Copilot pour recréer cet exemple

Ouvrez l’espace de travail dans lequel vous souhaitez créer l’exemple dans Visual Studio Code, basculez GitHub Copilot en mode agent, puis collez cette invite.

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.

Contenu connexe

  • Last updated on