Краткое руководство. Добавление поставщика Microsoft Entra в построитель API данных

В этом кратком руководстве используется пример Quickstart 3. Настройка Entra ID для настройки Data API builder (DAB) с помощью поставщика аутентификации Microsoft Entra ID. Веб-приложение и сущности DAB остаются анонимными, поэтому браузеру не нужен пользовательский интерфейс входа, MSAL или маркеры носителя.

В этом примере создается регистрация приложения Microsoft Entra, настраивается поставщик DAB EntraId с аудиторией и издателем и сохраняет роль anonymous активной. Этот подход позволяет добавить инфраструктуру проверки токенов, прежде чем потребуется вход в систему.

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

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

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

  • Статическое веб-приложение, которое вызывает DAB без входа пользователя.
  • DAB, настроенный с использованием EntraId поставщика проверки подлинности.
  • Регистрация приложения Microsoft Entra, в которой указываются аудитория и издатель для API DAB.
  • Права доступа к сущности, которые поддерживают активность роли anonymous.
  • Разрешения для сущности, включающие роль authenticated, чтобы DAB могла принимать корректные токены Bearer.
  • Аутентификация SQL из DAB к локальному контейнеру разработки SQL Server.
  • Беспарольный доступ DAB к Azure SQL через управляемую идентичность системного назначения.
  • .NET Aspire: оркестрация для локального SQL Server, DAB, веб-приложения, SQL Commander и MCP Inspector.
  • Развертывание и очистка Azure с помощью сценариев PowerShell в azure-infra.

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

Хоп Локальная проверка подлинности аутентификация Azure
От пользователя к веб-приложению Анонимный. Анонимный.
Веб-приложение к API Анонимный. Анонимный.
Поставщик проверки подлинности API EntraId, с анонимными сущностями EntraId, с анонимными сущностями
API для SQL Проверка подлинности SQL Системно назначенная управляемая идентичность

Important

DAB API проверяет токены Microsoft Entra, но разрешения для анонимных сущностей по-прежнему позволяют выполнять неаутентифицированные запросы. Добавьте более строгие разрешения, только если веб-приложение отправляет маркеры носителя.

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

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

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

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

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

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

dotnet tool restore

Войдите в Azure.

az login

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

dotnet run --project aspire-apphost

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

Веб-приложение загружается анонимно. Для DAB в фоновом режиме настроен поставщик EntraId.

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

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

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

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

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

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

Файлы ключей

Путь Purpose
data-api/dab-config.json Определяет поставщика проверки подлинности EntraId, аудиторию, эмитента и роли сущности.
aspire-apphost/Demo.cs Проверяет наличие заполнителей Microsoft Entra в dab-config.json и содержит инструкции по локальной настройке.
azure-infra/entra-setup.ps1 Создает или настраивает регистрацию приложения и аудиторию API.
azure-infra/entra-teardown.ps1 Удаляет регистрацию приложения во время завершения.
web-app/index.html, web-app/app.js, web-app/dab.js, web-app/config.js Статические веб-файлы, которые остаются анонимными и не используют MSAL.

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

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

You are GitHub Copilot running in agent mode. Recreate the Data API builder Quickstart 3 Microsoft Entra provider sample as a complete, runnable project in the current VS Code workspace under `quickstart-03-entra-provider`. Build a static anonymous web app, DAB with the `EntraId` provider configured, 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. Keep the web app anonymous and keep entities callable through the `anonymous` role. Do not add MSAL, sign-in UI, token acquisition, or bearer-token calls to the web app in this quickstart.

Source repository: https://github.com/Azure-Samples/dab-2.0-quickstart-web_anon-api_entra-db_entra. 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 demo schema unless the user requests a custom 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 a new Microsoft Entra app registration for the DAB API audience or reuse an existing app ID URI, audience, and issuer?
- Do you approve creating billable Azure resources and a Microsoft Entra app registration if the deployment phase 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` commands, `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`: https://learn.microsoft.com/azure/data-api-builder/command-line/dab-init
- `dab add`: 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 data.
- `web-app/` for static anonymous HTML, CSS, and JavaScript.
- `aspire-apphost/` for the .NET Aspire AppHost.
- `mcp-inspector/` for MCP Inspector notes or container assets.

Handle secrets and generated values first. Add `.env`, `**/bin`, and `**/obj` to `.gitignore` before writing secrets. Use `MSSQL_CONNECTION_STRING`, `ENTRA_TENANT_ID`, `ENTRA_AUDIENCE`, and `ENTRA_ISSUER`. 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` unless the sample explicitly uses 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 local config and validation:

```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 "anonymous:read"
dab validate --config data-api/dab-config.json
```

Use this DAB configuration shape if you write the config directly:

```json
{
	"data-source": {
		"database-type": "mssql",
		"connection-string": "@env('MSSQL_CONNECTION_STRING')"
	},
	"runtime": {
		"rest": { "enabled": true, "path": "/api" },
		"graphql": { "enabled": true, "path": "/graphql" },
		"mcp": { "enabled": true, "path": "/mcp" },
		"host": {
			"mode": "development",
			"authentication": {
				"provider": "EntraId",
				"jwt": {
					"audience": "@env('ENTRA_AUDIENCE')",
					"issuer": "@env('ENTRA_ISSUER')"
				}
			}
		}
	}
}
```

Keep anonymous entity permissions active. Also include `authenticated` where useful so a valid bearer token for the configured audience resolves to the `authenticated` role, but do not require tokens for the web app in this quickstart.

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 a passwordless Azure SQL connection string. Bake `dab-config.json` into the DAB image and replace CORS or endpoint placeholders before image build.

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

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.
- DAB `/health` returns a 2xx 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 loads anonymously and does not contain MSAL code.
- REST and GraphQL return seeded rows anonymously.
- A valid bearer token for the configured audience is accepted by DAB and maps to `authenticated`.
- MCP Inspector can list DAB tools and call `describe_entities` or an equivalent DAB MCP tool.
- SQL Commander opens and shows seeded tables.
- The web site returns a successful HTTP response.
- The app registration, audience, issuer, and tenant match DAB configuration.
- In Azure, the DAB Container App has a system-assigned managed identity and uses passwordless 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.

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

  • Last updated on