Início rápido: Usando a segurança em nível de linha no SQL com o Data API Builder

Neste início rápido, você usará o exemplo Quickstart 5 Row-Level Security para impor o isolamento de dados por usuário no SQL Server. O aplicativo Web autentica os usuários com o Microsoft Entra ID, envia um token bearer para o Data API builder (DAB), e a segurança em nível de linha (RLS) do SQL filtra as linhas na camada do banco de dados.

O exemplo usa a biblioteca de autenticação da Microsoft (MSAL) em um aplicativo de página única (SPA), a função authenticated do DAB e a segurança em nível de linha (RLS) do SQL Server com uma função de predicado e uma política de segurança. O DAB mapeia a declaração do preferred_username usuário autenticado para o SQL SESSION_CONTEXTe o SQL filtra linhas desse contexto de sessão. O exemplo não usa políticas de banco de dados por entidade do DAB ou código de API personalizado.

Pré-requisitos

  • .NET 8 ou posterior
  • Área de Trabalho do Docker
  • PowerShell
  • ferramentas .NET Aspire para orquestração local
  • CLI do Azure para instalação Microsoft Entra e implantação de Azure
  • sqlpackage se você fizer a implantação do projeto de banco de dados
  • Uma assinatura Azure com permissão para criar SQL do Azure, Aplicativos de Contêiner do Azure, Registro de Contêiner do Azure, Log Analytics e um grupo de recursos
  • Permissão para criar ou reutilizar registros de aplicativo Microsoft Entra

O que o exemplo mostra

  • Um aplicativo web estático que usa login com o navegador usando o MSAL e redirecionamento automático.
  • Um registro de aplicativo SPA para o aplicativo Web e um registro de aplicativo de API para DAB.
  • Um escopo de API delegado que o navegador solicita para chamadas de DAB.
  • Chamadas com token Bearer do aplicativo web para o DAB.
  • DAB configurado com o provedor de autenticação Microsoft Entra ID EntraId.
  • Permissões de entidade DAB que usam a authenticated função.
  • SQL Server RLS que filtra linhas pela declaração preferred_username do usuário conectado.
  • Contexto de sessão do DAB que mapeia declarações JWT (Token Web JSON) para SQL SESSION_CONTEXT.
  • Autenticação SQL do DAB para o contêiner local de desenvolvimento do SQL Server.
  • Acesso do DAB sem senha ao SQL do Azure usando uma identidade gerenciada atribuída pelo sistema.
  • Filtragem de dados por usuário em SQL sem políticas de banco de dados por entidade no DAB.

Fluxo de autenticação

Hop Autenticação local Autenticação do Azure
Do usuário para o aplicativo web Microsoft Entra ID com redirecionamento automático Microsoft Entra ID com redirecionamento automático
Aplicativo Web para API Token de portador Token de portador
Função de API authenticated authenticated
API para SQL Autenticação SQL com a SQL RLS Identidade gerenciada atribuída pelo sistema com SQL RLS

Comparar com a série

Step O que muda
Anterior Use políticas do DAB para dados por usuário filtra linhas no DAB com expressões de política.
Este início rápido Move a filtragem por usuário para o SQL RLS usando o contexto de sessão populado por DAB.
Próximo A autenticação em nome de permite que o SQL do Azure autentique o usuário real conectado.

Política RLS

O SQL Server aplica o controle de acesso em nível de linha por meio de uma função de predicado e de uma política de segurança.

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);

O DAB envia declarações JWT autenticadas para o contexto da sessão SQL quando data-source.options.set-session-context é true.

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

O banco de dados retorna apenas linhas em que a Owner coluna corresponde SESSION_CONTEXT(N'preferred_username'). O DAB pode solicitar linhas normalmente; O SQL impõe o filtro final.

Importante

Este exemplo não usa políticas de banco de dados DAB, como @item.Owner eq @claims.preferred_username. O SQL RLS é proprietário do filtro de linha.

Utilize o exemplo

Clone o repositório de exemplo.

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 ferramentas locais.

dotnet tool restore

Inicie sessão no Azure.

az login

Execute o exemplo localmente.

dotnet run --project aspire-apphost

Na primeira execução, o Aspire verifica a configuração de Microsoft Entra. Se os valores de configuração estiverem ausentes, o exemplo oferece a opção de executar interativamente o fluxo de configuração do Microsoft Entra. O script de instalação cria ou configura os registros do aplicativo, atualiza web-app/config.js e data-api/dab-config.jsoninicia os recursos locais.

O aplicativo web redireciona usuários para a página de entrada da Microsoft. Após o login, as chamadas à API incluem tokens Bearer, o DAB mapeia preferred_username para o contexto de sessão do SQL, e o SQL RLS retorna apenas as linhas correspondentes.

Implante o exemplo para Azure.

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

O script de implantação provisiona os recursos do SQL do Azure e do Aplicativos de Contêiner do Azure para o DAB, o aplicativo web, o Model Context Protocol (MCP) Inspector e o SQL Commander. Também configura o aplicativo de contêiner DAB com uma identidade gerenciada atribuída pelo sistema e executa azure-infra/post-provision.ps1 para implantar o banco de dados, criar o usuário da identidade gerenciada, conceder funções no banco de dados e verificar a configuração do RLS.

Limpe os recursos do Azure e os registros de aplicativos quando terminar.

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

O fluxo de limpeza exclui recursos do Azure e executa o script de desmontagem do Microsoft Entra. Se você precisar remover os registros de aplicativos separadamente, execute o script de desmontagem na pasta azure-infra do exemplo.

Arquivos de chave

Caminho Purpose
data-api/dab-config.json Define o EntraId provedor, a authenticated função e a set-session-context configuração.
database/Functions/UserFilterPredicate.sql Define a função de predicado de RLS que compara Owner a SESSION_CONTEXT(N'preferred_username').
database/Security/UserFilterPolicy.sql Define a política de segurança UserFilterPolicy em dbo.Todos.
web-app/auth.js Configura MSAL, redirecionamento automático, aquisição de token e a ação de saída.
web-app/dab.js Envia Authorization: Bearer <token> cabeçalhos em chamadas DAB.
web-app/config.js Armazena a ID do locatário, a ID do cliente SPA, a URL da API e o escopo da API para MSAL.
azure-infra/post-provision.ps1 Implanta o dacpac, define o SQL do Azure Microsoft Entra administrador, cria o usuário de identidade gerenciada, concede funções de banco de dados e atualiza as configurações do DAB e do aplicativo Web.

Use GitHub Copilot para recriar este exemplo

Abra o workspace no qual você deseja criar o exemplo em Visual Studio Code, alterne GitHub Copilot para o modo de agente e cole esse prompt.

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.