Szybki start: dodawanie dostawcy Microsoft Entra do narzędzia Data API builder

W tym przewodniku Szybki start skorzystasz z przykładu Szybki start 3: konfigurowanie Entra ID, aby skonfigurować narzędzie Data API builder (DAB) za pomocą dostawcy uwierzytelniania Microsoft Entra ID. Aplikacja internetowa i encje DAB pozostają anonimowe, więc przeglądarka nie potrzebuje interfejsu logowania, biblioteki MSAL ani tokenów okaziciela.

Przykład tworzy rejestrację aplikacji Microsoft Entra, konfiguruje dostawcę DAB EntraId za pomocą wartości audience i issuer oraz pozostawia rolę anonymous aktywną. Ten wzorzec umożliwia dodanie infrastruktury weryfikacji tokenu przed wymaganiem logowania.

Wymagania wstępne

Co pokazano w przykładzie

  • Statyczna aplikacja internetowa, która wywołuje DAB bez logowania się użytkownika.
  • DAB skonfigurowany z dostawcą uwierzytelniania EntraId.
  • Rejestracja aplikacji Microsoft Entra dostarczająca odbiorców i wystawcę interfejsu API DAB.
  • Uprawnienia encji, które utrzymują rolę anonymous jako aktywną.
  • Uprawnienia encji obejmujące rolę authenticated, aby DAB mógł akceptować prawidłowe tokeny okaziciela.
  • Uwierzytelnianie SQL z języka DAB do lokalnego kontenera deweloperskiego SQL Server.
  • Bezhasłowy dostęp usługi DAB do Azure SQL za pośrednictwem tożsamości zarządzanej przypisanej przez system.
  • Orkiestracja .NET Aspire dla lokalnego serwera SQL, DAB, aplikacji internetowej, SQL Commander i MCP Inspector.
  • Wdrażanie i czyszczenie na platformie Azure za pomocą skryptów programu PowerShell w azure-infra.

Przepływ uwierzytelniania

Hop Uwierzytelnianie lokalne Uwierzytelnianie platformy Azure
Użytkownik → aplikacja internetowa Anonimowy Anonimowy
Aplikacja internetowa do API Anonimowy Anonimowy
Dostawca uwierzytelniania interfejsu API EntraId, z jednostkami anonimowymi EntraId, z jednostkami anonimowymi
API na SQL Uwierzytelnianie SQL Tożsamość zarządzana przypisana przez system

Important

Interfejs API języka DAB weryfikuje tokeny Microsoft Entra, ale uprawnienia jednostki anonimowej nadal zezwalają na nieuwierzytelnione żądania. Dodaj bardziej restrykcyjne uprawnienia tylko wtedy, gdy aplikacja internetowa wysyła tokeny okaziciela.

Porównanie z serią

Step Co się zmienia
Wstecz Użycie tożsamości zarządzanej usuwa hasło usługi Azure SQL, ale pozostawia aplikację internetową i interfejs API bez uwierzytelniania.
Ten przewodnik szybkiego startu Dodaje dostawcę Microsoft Entra, odbiorcę i wystawcę, jednocześnie pozostawiając aktywny dostęp anonimowy.
Dalej Użyj zasad DAB dla danych poszczególnych użytkowników wymaga zalogowania i filtruje wiersze za pomocą wyrażeń zasad DAB.

Korzystanie z przykładu

Sklonuj przykładowe repozytorium.

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

Przywracanie narzędzi lokalnych.

dotnet tool restore

Zaloguj się do Azure.

az login

Uruchom przykład lokalnie.

dotnet run --project aspire-apphost

Przy pierwszym uruchomieniu Aspire sprawdza dab-config.json pod kątem symboli zastępczych Microsoft Entra. Jeśli dostawca nie jest skonfigurowany, aplikacja oferuje uruchomienie azure-infra/entra-setup.ps1 w trybie interaktywnym. Skrypt tworzy lub konfiguruje rejestrację aplikacji, aktualizuje odbiorców i wystawcę, a następnie uruchamia zasoby lokalne.

Aplikacja internetowa jest ładowana anonimowo. DaB ma skonfigurowanego dostawcę EntraId w tle.

Wdróż przykład w Azure.

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

Skrypt wdrażania tworzy zasoby Azure SQL i Azure Container Apps dla DAB, aplikacji internetowej, MCP Inspector i SQL Commander. Konfiguruje również tożsamość zarządzaną przypisaną przez system dla aplikacji kontenerowej DAB i przekazuje do DAB wartości audience i issuer usługi Microsoft Entra.

Usuń zasoby platformy Azure i rejestrację aplikacji po zakończeniu.

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

Proces oczyszczania uruchamia skrypt demontażu Microsoft Entra. Jeśli musisz usunąć rejestrację aplikacji oddzielnie, uruchom polecenie azure-infra/entra-teardown.ps1 z przykładu.

Kluczowe pliki

Path Purpose
data-api/dab-config.json Definiuje dostawcę uwierzytelniania EntraId, odbiorców tokenu, wystawcę tokenu i role jednostki.
aspire-apphost/Demo.cs Sprawdza symbole zastępcze Microsoft Entra w dab-config.json i przeprowadza lokalną konfigurację.
azure-infra/entra-setup.ps1 Tworzy lub konfiguruje rejestrację aplikacji i odbiorcę API.
azure-infra/entra-teardown.ps1 Usuwa rejestrację aplikacji podczas demontażu.
web-app/index.html, , web-app/app.js, , web-app/dab.jsweb-app/config.js Statyczne pliki internetowe, które pozostają anonimowe i nie używają biblioteki MSAL.

Użyj GitHub Copilot, aby ponownie utworzyć ten przykład

Otwórz obszar roboczy, w którym chcesz utworzyć przykład w Visual Studio Code, przełącz GitHub Copilot do trybu agenta i wklej ten monit.

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.

Treści powiązane

  • Last updated on