Краткое руководство: использование аутентификации от имени пользователя с Data API builder

В этом кратком руководстве вы используете пример Quickstart 6 On-Behalf-Of Flow для запуска построителя API данных (DAB) с проверкой подлинности, делегированной пользователем. Веб-приложение выполняет вход пользователей в систему с помощью Microsoft Entra ID, отправляет токены предъявителя в DAB, а DAB обменивает каждый токен на токен Azure SQL для пользователя, выполнившего вход.

В примере используется Azure SQL, так как локальные SQL Server не могут принимать маркеры Microsoft Entra. Представление WhoAmI, запускаемое с помощью SELECT SUSER_NAME(), доказывает, что SQL видит фактического вызывающего, а не управляемую идентичность DAB.

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

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

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

  • Статическое веб-приложение, использующее вход в браузер MSAL.
  • Вызовы с токеном Bearer из веб-приложения в DAB.
  • DAB, настроенный с помощью поставщика проверки подлинности Microsoft Entra ID EntraId.
  • DAB user-delegated-auth , настроенный для обмена токенами OBO.
  • Регистрация API-приложения с секретом клиента для OBO-обмена.
  • База данных SQL Azure: делегированное разрешение user_impersonation с согласия администратора.
  • Простая строка подключения Azure SQL без ключевого слова User ID, Password или Authentication.
  • Сущности DAB с проверкой подлинности и без анонимного доступа.
  • Автономные пользователи Azure SQL для пользователей, выполнивших вход.
  • Представление WhoAmI, которое возвращает SUSER_NAME() для проверки идентичности вызывающей стороны SQL.
  • Развертывание и очистка Azure с помощью сценариев PowerShell в azure-infra.

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

Хоп Authentication
Пользователь → веб-приложение Вход в браузер MSAL с помощью Microsoft Entra ID
Веб-приложение для API DAB Маркер носителя для аудитории API DAB
Роль API DAB authenticated
DAB для Azure SQL Токен OBO для пользователя, который фактически вошёл в систему

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

Step Какие изменения
Previous Использование фильтров безопасности на уровне строк в SQL фильтрует строки в SQL, но при этом в SQL по-прежнему выполняется проверка подлинности удостоверения службы DAB.
Это краткое руководство Использует OBO, поэтому Azure SQL аутентифицирует реального вошедшего пользователя для аудита и политик, учитывающих пользователя.
Следующая Настройка проверки подлинности OBO подробно описывает свойства конфигурации OBO.

Поведение только для Azure

Для OBO требуется Azure SQL с проверкой подлинности Microsoft Entra. Локальный контейнер SQL Server не может принимать маркеры Microsoft Entra, поэтому полный путь OBO доступен только для Azure.

Используйте строку подключения к Azure SQL без дополнительных параметров, чтобы DAB мог подставлять пользовательский токен OBO в каждый аутентифицированный запрос.

Server=tcp:<server>.database.windows.net,1433;Database=<database>;Encrypt=True;TrustServerCertificate=False;

Не включайте эти значения в строку подключения OBO:

  • User ID
  • Password
  • Authentication

Important

Если строка подключения включает Authentication=, клиентские библиотеки SQL отклоняют запрос, если DAB также предоставляет маркер доступа.

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

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

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

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

dotnet tool restore

Войдите в Azure.

az login

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

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

Скрипт развертывания подготавливает ресурсы Azure SQL и Контейнеры приложений Azure для DAB, веб-приложения, инспектора MCP и командира SQL. Также выполняется настройка Microsoft Entra, создается секрет клиента приложения API, добавляется делегированное разрешение База данных SQL Azure user_impersonation, предоставляется согласие администратора, развертывается база данных, создаются изолированные пользователи и настраивается DAB для OBO.

После развертывания откройте URL-адрес веб-приложения, напечатанный скриптом. Войдите и убедитесь, что на значке SQL Server sees you as указано ваше имя участника-пользователя. Бейдж считывает данные сущности WhoAmI, связанной с SELECT SUSER_NAME().

Анонимные запросы API должны возвращать 401 Unauthorized.

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

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

Файлы ключей

Путь Purpose
data-api/dab-config.json Включает user-delegated-auth, отключает кэш, настраивает EntraId и предоставляет сущность представления WhoAmI.
database/Views/WhoAmI.sql Определяет SELECT SUSER_NAME() AS UserName для проверки подлинности.
web-app/index.html Отображает пользователя, выполнившего вход, и значок удостоверения SQL.
web-app/app.js Координирует вход, обновления страниц и обновление удостоверений.
web-app/dab.js Отправляет запросы маркера носителя в DAB и считывает WhoAmI.
azure-infra/entra-setup.ps1 Создает регистрации приложений в Microsoft Entra, создает секрет клиента для API, добавляет делегированное разрешение База данных SQL Azure user_impersonation и предоставляет согласие администратора.
azure-infra/resources.bicep Определяет ресурсы Azure и передает в DAB базовую строку подключения к Azure SQL и параметры OBO.
azure-infra/post-provision.ps1 Развертывает базу данных, задает администратора Azure SQL Microsoft Entra, создает содержащихся пользователей и настраивает значения среды OBO.

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

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

You are GitHub Copilot running in agent mode. Recreate the Data API builder Quickstart 6 On-Behalf-Of Flow sample as a complete Azure-only project in the current VS Code workspace under `quickstart-06-on-behalf-of`. Build a static SPA with MSAL browser sign-in, DAB with Microsoft Entra bearer-token validation and OBO user-delegated authentication, Azure SQL, REST, GraphQL, MCP, .NET Aspire build orchestration, SQL Commander, MCP Inspector, and Azure Container Apps deployment scripts. DAB is the only API, GraphQL, and MCP layer over SQL. SQL must authenticate the actual signed-in user, not the DAB managed identity or service principal.

Source repository: https://github.com/Azure-Samples/dab-2.0-quickstart-web_entra-api_entra-db_entra-obo. 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.

Azure-only constraint: do not build a local SQL Server OBO path. Local SQL Server cannot accept Microsoft Entra tokens. Use local tooling only for project generation, web app development, DAB config validation where possible, container builds, and database package builds.

Start with a short plan and proceed with safe defaults before you create files or run commands. Use the default `WhoAmI` view unless the user explicitly asks for additional schema. 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 SPA and API app registrations or reuse existing registrations?
- Confirm that the API app can use a client secret. OBO requires a confidential client.
- Confirm that the API app should receive Azure SQL Database delegated `user_impersonation` permission and admin consent.
- Which Microsoft Entra user or group should become the Azure SQL Microsoft Entra admin?
- Which signed-in users or groups should become contained database users for validation?
- Do you approve creating billable Azure resources, app registrations, and an API app client secret if deployment starts?

After the answers, show a checklist and ask for approval before implementation. Include phases for scaffold, Entra setup, database package, Azure infrastructure, post-provision, validation, and cleanup. Do not run `az`, `az ad`, `azd`, 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 and it supports Microsoft Entra/OBO validation; otherwise choose the lowest-cost SQL option that supports user-delegated authentication. 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 create app registrations and grant admin consent, `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 configure` OBO options: 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
- OBO concept: https://learn.microsoft.com/azure/data-api-builder/concept/security/authenticate-on-behalf-of
- User-delegated auth configuration: https://learn.microsoft.com/azure/data-api-builder/configuration/data-source#user-delegated-auth

Create this structure under the sample folder:

- `azure-infra/` for Bicep, `azure-up.ps1`, `azure-down.ps1`, `entra-setup.ps1`, `entra-teardown.ps1`, `resources.bicep`, and `post-provision.ps1`.
- `data-api/` for `dab-config.json` and a DAB Dockerfile that bakes the config into the image.
- `database/` for a SQL Database Project, seed data, and `Views/WhoAmI.sql`.
- `web-app/` for static HTML, CSS, and JavaScript with MSAL browser support.
- `aspire-apphost/` for build orchestration only.
- `mcp-inspector/` for MCP Inspector container assets and nginx same-origin proxy config.

Handle secrets first. Add `.env`, `**/bin`, and `**/obj` to `.gitignore` before writing secrets or local configuration. Store the API client secret only in local `.env` files for local preparation and in Azure Key Vault or Azure Container Apps secrets for Azure. Never inline secret values in Bicep, PowerShell scripts, generated JSON, logs, or reports. Generate secret references for Container Apps instead of plaintext environment values. Never print tokens, passwords, or client secret values. Redact all secret values as `***redacted***`.

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: any local web origin used for development and the deployed Azure Container Apps web FQDN. 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 for config shaping and validation where possible:

```dotnetcli
dab init --database-type mssql --connection-string "@env('DATABASE_CONNECTION_STRING')" --auth.provider EntraID --auth.audience "@env('ENTRA_AUDIENCE')" --auth.issuer "@env('ENTRA_ISSUER')" --rest.enabled true --graphql.enabled true --mcp.enabled true
dab configure --data-source.user-delegated-auth.enabled true --data-source.user-delegated-auth.provider EntraId --data-source.user-delegated-auth.database-audience "https://database.windows.net"
dab add WhoAmI --source dbo.vw_WhoAmI --source.type view --source.key-fields "UserName" --permissions "authenticated:read" --mcp.dml-tools true
dab validate --config data-api/dab-config.json
```

Use a bare Azure SQL connection string so DAB can inject the per-user OBO access token. Do not include `User ID`, `Password`, or `Authentication`.

```text
Server=tcp:<server>.database.windows.net,1433;Database=<database>;Encrypt=True;TrustServerCertificate=False;
```

Use this DAB data-source shape for OBO:

```json
{
	"data-source": {
		"database-type": "mssql",
		"connection-string": "@env('DATABASE_CONNECTION_STRING')",
		"user-delegated-auth": {
			"enabled": true,
			"provider": "EntraId",
			"database-audience": "https://database.windows.net"
		}
	}
}
```

Create `database/Views/WhoAmI.sql` to prove SQL sees the signed-in user.

```sql
CREATE VIEW dbo.vw_WhoAmI AS
SELECT CAST(SUSER_NAME() AS nvarchar(256)) AS 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}` };
}
```

For Azure, bake `dab-config.json` into the DAB image. Do not rely on volume mounts in Azure Container Apps.

```dockerfile
FROM mcr.microsoft.com/azure-databases/data-api-builder:latest
COPY dab-config.json /App/dab-config.json
```

Before any Azure post-provision command, list the exact `az`, `az acr`, `az containerapp`, and `sqlpackage` commands you intend to run and wait for explicit user approval. Post-provision in this order: deploy dacpac, set the Azure SQL Microsoft Entra admin, create contained database users or groups for validation, grant access to demo objects and `WhoAmI`, replace placeholders, build and push the DAB image, then update Container Apps.

```powershell
dotnet build database/database.sqlproj -c Release
sqlpackage /Action:Publish /SourceFile:database/bin/Release/database.dacpac /TargetConnectionString:"$sqlConn" /p:BlockOnPossibleDataLoss=false
az acr build --registry $acrName --image dab-api:latest --file ./data-api/Dockerfile ./data-api/
az containerapp update --name $dabAppName --resource-group $resourceGroup --image "$acrName.azurecr.io/dab-api:latest"
```

Deploy MCP Inspector with a same-origin proxy pattern and set `MCP_SERVER_URL` to the DAB `/mcp` endpoint.

```nginx
location /mcp {
	proxy_pass http://127.0.0.1:6277;
	proxy_http_version 1.1;
	proxy_set_header Upgrade $http_upgrade;
	proxy_set_header Connection "upgrade";
	proxy_buffering off;
}
```

Deploy SQL Commander with env var `ConnectionStrings__db` and ensure the connection string includes `TrustServerCertificate=true`.

```text
ConnectionStrings__db=Server=<server>.database.windows.net;Database=<database>;User Id=<user>;Password=<password>;TrustServerCertificate=true
```

Validation must prove OBO, not only API authentication:

- A direct Azure SQL query confirms the database is reachable, the deployed objects exist, and required contained users or groups exist.
- 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.
- The web app signs in with Microsoft Entra ID.
- Signed-in REST, GraphQL, and MCP calls include bearer headers and reach DAB under the `authenticated` role.
- The `WhoAmI` entity returns the signed-in user's UPN from `SUSER_NAME()`.
- `WhoAmI` does not return the DAB managed identity, service principal, or Container App identity.
- Anonymous REST and GraphQL calls return `401`.
- The DAB Container App database connection string contains no SQL password, no `User ID`, and no `Authentication` keyword.
- The API client secret exists only as a secret reference or redacted local value.
- MCP Inspector connects to DAB MCP with streamable HTTP.
- SQL Commander can browse the deployed schema.
- Required contained users or groups exist in Azure SQL.

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.

Troubleshoot with these checks:

- OBO token exchange fails: verify the API app has Azure SQL Database delegated `user_impersonation` permission and admin consent.
- SQL login fails for a token-identified principal: add the signed-in user or group as a contained user in the database.
- DAB returns 401 for valid bearer tokens: verify audience and issuer values in `dab-config.json`.
- SQL sees the service identity instead of the user: verify `user-delegated-auth`, the API client secret, and the bare SQL connection string.

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

  • Last updated on