Inicio rápido: Usar la seguridad a nivel de fila de SQL con Data API Builder

En este inicio rápido, usará el ejemplo Quickstart 5 Row-Level Security para aplicar el aislamiento de datos por usuario en SQL Server. La aplicación web inicia la sesión de los usuarios con Microsoft Entra ID, envía un token de portador a Data API Builder (DAB) y la seguridad de nivel de fila (RLS) de SQL filtra las filas en la capa de la base de datos.

En el ejemplo se usa la biblioteca de autenticación de Microsoft (MSAL) en una aplicación de una sola página (SPA), el rol DAB authenticated y la seguridad de nivel de fila (RLS) de SQL Server con una función de predicado y una directiva de seguridad. DAB asigna la declaración del usuario autenticado preferred_username a SQL SESSION_CONTEXT, y SQL filtra las filas usando ese contexto de sesión. El ejemplo no usa directivas de base de datos DAB por entidad ni código de API personalizado.

Prerequisites

¿Qué muestra el ejemplo?

  • Una aplicación web estática que usa el inicio de sesión del explorador MSAL y la redirección automática.
  • Un registro de aplicación SPA para la aplicación web y un registro de aplicación de API para DAB.
  • Ámbito de API delegado que el explorador solicita para llamadas DAB.
  • Llamadas de token de portador desde la aplicación web a DAB.
  • DAB configurado con el proveedor de autenticación Microsoft Entra ID EntraId.
  • Permisos de entidad de DAB que usan el rol authenticated.
  • RLS de SQL Server que filtra las filas según la declaración preferred_username del usuario autenticado.
  • Contexto de sesión de DAB que asigna las declaraciones de JSON Web Token (JWT) a SQL SESSION_CONTEXT.
  • Autenticación de SQL de DAB al contenedor de desarrollo de SQL Server local.
  • Acceso DAB sin contraseña a Azure SQL a través de una identidad administrada asignada por el sistema.
  • Filtrado de datos por usuario en SQL sin directivas de base de datos por entidad DAB.

Flujo de autenticación

Salto Autenticación local Autenticación de Azure
Usuario a la aplicación web Microsoft Entra ID con redirección automática Microsoft Entra ID con redirección automática
De aplicación web a API Token de portador Token de portador
Rol de API authenticated authenticated
API para SQL Autenticación de SQL con SQL RLS Identidad administrada asignada por el sistema con SQL RLS

Comparación con la serie

Step Qué cambios
Anterior Usar directivas de DAB para datos por usuario filtra filas en DAB mediante expresiones de directiva.
Este inicio rápido Mueve el filtrado por usuario a SQL RLS mediante el contexto de sesión rellenado por DAB.
Siguiente Usar la autenticación en nombre de otro permite a Azure SQL autenticar al usuario real que ha iniciado sesión.

Política de RLS

SQL Server implementa el acceso a nivel de fila con una función de predicado y una política de seguridad.

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 envía declaraciones JWT autenticadas al contexto de la sesión de SQL cuando data-source.options.set-session-context es true.

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

La base de datos devuelve solo filas donde la Owner columna coincide con SESSION_CONTEXT(N'preferred_username'). DAB puede solicitar filas normalmente; SQL aplica el filtro final.

Importante

En este ejemplo no se usan directivas de base de datos DAB como @item.Owner eq @claims.preferred_username. SQL RLS posee el filtro de fila.

Uso del ejemplo

Clona el repositorio de ejemplo.

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

Restaurar herramientas locales.

dotnet tool restore

Inicie sesión en Azure.

az login

Ejecute el ejemplo localmente.

dotnet run --project aspire-apphost

En la primera ejecución, Aspire comprueba la configuración de Microsoft Entra. Si faltan valores de configuración, el ejemplo ofrece ejecutar el flujo de configuración de Microsoft Entra de forma interactiva. El script de instalación crea o configura los registros de aplicaciones, las actualizaciones web-app/config.js y data-api/dab-config.json, e inicia los recursos locales.

La aplicación web redirige a los usuarios a la página de inicio de sesión de Microsoft. Después de iniciar sesión, las llamadas a la API incluyen tokens bearer, DAB asigna preferred_username al contexto de sesión de SQL y SQL RLS solo devuelve las filas correspondientes.

Implemente el ejemplo en Azure.

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

El script de implementación aprovisiona recursos Azure SQL y Azure Container Apps para DAB, la aplicación web, el Inspector del Protocolo de contexto de modelo (MCP) y SQL Commander. También configura la aplicación contenedora de DAB con una identidad administrada asignada por el sistema y ejecuta azure-infra/post-provision.ps1 para implementar la base de datos, crear el usuario de identidad administrada, conceder roles de base de datos y verificar la configuración de RLS.

Limpie Azure recursos y registros de aplicaciones cuando haya terminado.

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

El flujo de limpieza elimina los recursos de Azure y ejecuta el script de desmontaje de Microsoft Entra. Si necesita eliminar los registros de aplicaciones por separado, ejecute el script de limpieza desde la carpeta azure-infra del ejemplo.

Archivos clave

Camino propósito
data-api/dab-config.json Define el proveedor EntraId, el rol authenticated y la configuración set-session-context.
database/Functions/UserFilterPredicate.sql Define la función de predicado de RLS que compara Owner con SESSION_CONTEXT(N'preferred_username').
database/Security/UserFilterPolicy.sql Define la UserFilterPolicy directiva de seguridad en dbo.Todos.
web-app/auth.js Configura MSAL, redirección automática, adquisición de tokens y la acción de cierre de sesión.
web-app/dab.js Envía Authorization: Bearer <token> encabezados con llamadas DAB.
web-app/config.js Almacena el ID del inquilino, el ID de cliente de SPA, la dirección URL de la API y el ámbito de la API para MSAL.
azure-infra/post-provision.ps1 Despliega el dacpac, configura el administrador de Microsoft Entra para Azure SQL, crea el usuario de identidad administrada, asigna roles de base de datos y actualiza la configuración de DAB y de la aplicación web.

Uso de GitHub Copilot para volver a crear este ejemplo

Abra el área de trabajo en la que desea crear el ejemplo en Visual Studio Code, cambie GitHub Copilot al modo de agente y pegue este mensaje.

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.

Contenido relacionado

  • Last updated on