Краткое руководство: использование политик Data API Builder для пользовательских данных

В этом кратком руководстве вы используете пример Quickstart 4 User Authentication with DAB Policies sample для фильтрации данных по вошедшему пользователю. Веб-приложение выполняет аутентификацию пользователей через Microsoft Entra ID, отправляет токен носителя в Data API builder (DAB), а DAB применяет политику доступа к базе данных, прежде чем вернуть строки результата SQL-запроса.

В примере используются Microsoft Authentication Library (MSAL) в одностраничном приложении (SPA), роль DAB authenticated и выражение политики @item.Owner eq @claims.preferred_username. В этом примере не используется секрет клиента или пользовательский код API.

Необходимые условия

  • .NET 8 или более поздней версии
  • Docker Desktop
  • PowerShell
  • Средства .NET Aspire для локальной оркестрации
  • Azure CLI для настройки Microsoft Entra и развертывания в Azure
  • sqlpackage при развертывании проекта базы данных
  • Подписка Azure с разрешением на создание Azure SQL, Контейнеры приложений Azure, Реестр контейнеров Azure, Log Analytics и группы ресурсов
  • Разрешение на создание или повторное использование регистрации приложений Microsoft Entra

Как показано в примере

  • Статическое веб-приложение, использующее вход в браузер MSAL и автоматическое перенаправление.
  • Регистрация приложения SPA для веб-приложения и регистрации приложения API для DAB.
  • Делегированная область API, запрашиваемая браузером для вызовов DAB.
  • Запросы из веб-приложения к DAB с токеном Bearer.
  • DAB, настроенный с помощью поставщика проверки подлинности Microsoft Entra ID EntraId.
  • Разрешения для сущности DAB с ролью authenticated.
  • Политика базы данных DAB, которая фильтрует строки по утверждению вошедшего пользователя.
  • Аутентификация SQL из DAB к локальному контейнеру разработки SQL Server.
  • Беспарольный доступ DAB к Azure SQL через управляемую идентичность системного назначения.
  • Фильтрация данных для каждого пользователя в DAB без специального кода API или секрета клиента.

Поток аутентификации

Хоп Локальная проверка подлинности аутентификация Azure
От пользователя к веб-приложению Microsoft Entra ID с автоматическим перенаправлением Microsoft Entra ID с автоматическим перенаправлением
Веб-приложение к API Токен носителя Токен носителя
Роль API authenticated authenticated
API для SQL Проверка подлинности SQL с помощью политики DAB Назначаемое системой управляемое удостоверение с политикой DAB

Сравнение с серией

Step Какие изменения
Previous Добавление поставщика Microsoft Entra проверяет токены, но по-прежнему разрешает анонимный доступ к сущностям.
Это краткое руководство Требуется вход MSAL, отправка маркеров носителя в DAB и фильтрация строк с помощью политики базы данных DAB.
Следующая Использование безопасности на уровне строк SQL перемещает фильтрацию на пользователя из DAB в SQL.

Политика

DAB применяет эту политику в отношении базы данных к действиям защищённых сущностей.

@item.Owner eq @claims.preferred_username

Политика позволяет вошедшего пользователя получать доступ только к строкам, в которых Owner столбец соответствует утверждению пользователя preferred_username . Удалите роль anonymous из защищённых объектов, чтобы анонимные запросы к REST и GraphQL возвращали 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"
              }
            }
          ]
        }
      ]
    }
  }
}

Использование примера

Клонируйте пример репозитория.

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

Восстановить локальные инструменты.

dotnet tool restore

Войдите в Azure.

az login

Запустите пример локально.

dotnet run --project aspire-apphost

При первом запуске Aspire проверяет конфигурацию Microsoft Entra. Если отсутствуют значения конфигурации, пример предлагает интерактивное выполнение azure-infra/entra-setup.ps1 . Скрипт установки создает или настраивает регистрации приложений, обновляет web-app/config.js и data-api/dab-config.json, а также запускает локальные ресурсы.

Веб-приложение перенаправляет пользователей на страницу входа Microsoft. После входа в систему вызовы API включают токены bearer, и каждый пользователь видит только строки, соответствующие его утверждению preferred_username.

Разверните пример для Azure.

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

Скрипт развертывания создаёт и настраивает ресурсы Azure SQL и Контейнеры приложений Azure для DAB, веб-приложения, MCP Inspector и SQL Commander. Он также настраивает контейнерное приложение DAB с управляемой идентификацией, назначаемой системой, и выполняет настройку Microsoft Entra при развертывании.

По завершении работы удалите ресурсы Azure и регистрации приложений.

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

Процесс очистки запускает скрипт демонтажа Microsoft Entra. Если необходимо удалить регистрации приложений отдельно, запустите azure-infra/entra-teardown.ps1 из примера.

Файлы ключей

Путь Purpose
data-api/dab-config.json Определяет поставщика EntraId, роль authenticated и политику базы данных.
web-app/auth.js Настраивает MSAL, автоматическое перенаправление, получение токена и действие выхода из системы.
web-app/index.html Загружает поддержку MSAL для браузера и отображает элементы пользовательского интерфейса для аутентифицированных пользователей.
web-app/app.js Инициализирует приложение после проверки подлинности и обновляет состояние входа.
web-app/dab.js Отправляет Authorization: Bearer <token> заголовки при вызовах DAB.
web-app/config.js Сохраняет идентификатор арендатора, идентификатор клиента SPA и область API для MSAL.

Используйте GitHub Copilot, чтобы воссоздать этот пример

Откройте рабочую область, в которой вы хотите создать пример в Visual Studio Code, переключите GitHub Copilot в режим агента и вставьте этот запрос.

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.

Связанный контент

  • Last updated on