Início rápido: Adicionar um provedor Microsoft Entra ao Data API builder

Neste guia de introdução rápida, utiliza o exemplo Quickstart 3 - Configurar o Entra ID para configurar o Data API builder (DAB) com um fornecedor de autenticação do Microsoft Entra ID. A aplicação web e as entidades DAB mantêm-se anónimas, pelo que o navegador não precisa de interface de login, MSAL ou tokens portadores.

O exemplo cria um registo de aplicação no Microsoft Entra, configura o fornecedor DAB EntraId com uma audiência e um emissor, e mantém a função anonymous ativa. Este padrão permite-lhe adicionar infraestrutura de validação de tokens antes de precisar de iniciar sessão.

Pré-requisitos

O que o exemplo mostra

  • Uma aplicação web estática que chama DAB sem login do utilizador.
  • DAB configurado com o provedor de autenticação EntraId.
  • Um registo de aplicação do Microsoft Entra que fornece o público-alvo e o emissor da API DAB.
  • Permissões da entidade que mantêm a função anonymous ativa.
  • Permissões de entidade que incluem a função authenticated para que o DAB aceite tokens de portador válidos.
  • Autenticação SQL do DAB para o contentor local de desenvolvimento do SQL Server.
  • Acesso DAB sem palavra-passe ao SQL do Azure através de uma identidade gerida atribuída pelo sistema.
  • Orquestração do .NET Aspire para o SQL Server local, DAB, a aplicação Web, SQL Commander e MCP Inspector.
  • Implementação e limpeza do Azure com scripts do PowerShell em azure-infra.

Fluxo de autenticação

Hop Autenticação local Autenticação do Azure
Utilizador para a aplicação web Anônimo Anônimo
Da aplicação Web para a API Anônimo Anônimo
Fornecedor de autenticação API EntraId, com entidades anónimas EntraId, com entidades anónimas
API para SQL Autenticação do SQL Identidade gerenciada atribuída ao sistema

Important

A API DAB valida tokens Microsoft Entra, mas permissões anónimas de entidades ainda permitem pedidos não autenticados. Adicionar permissões mais restritivas apenas quando a aplicação web enviar tokens de portador.

Comparar com a série

Step O que muda
Anterior Utilizar identidade gerida remove a palavra-passe do SQL do Azure, mas deixa a aplicação Web e a API anónimas.
Este início rápido Adiciona um provedor, um público e um emissor do Microsoft Entra, mantendo o acesso anónimo ativado.
Next Utilizar políticas DAB para dados por utilizador requer início de sessão e filtra linhas com expressões de política do DAB.

Use o exemplo

Clona o repositório de exemplos.

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

Restaurar ferramentas locais.

dotnet tool restore

Inicie sessão no Azure.

az login

Executa o exemplo localmente.

dotnet run --project aspire-apphost

Na primeira execução, o Aspire verifica se existem marcadores de posição do Microsoft Entra em dab-config.json. Se o provedor não estiver configurado, a aplicação propõe executar azure-infra/entra-setup.ps1 de modo interativo. O script cria ou configura o registo da aplicação, atualiza o público e o emissor, e depois inicia os recursos locais.

A aplicação web carrega anonimamente. O DAB tem o EntraId provedor configurado internamente.

Implemente o exemplo no Azure.

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

O script de implementação prevê recursos SQL do Azure e Azure Container Apps para DAB, a aplicação web, MCP Inspector e SQL Commander. Também configura uma identidade gerida atribuída pelo sistema para a aplicação DAB Container e encaminha a audiência e o emissor da Microsoft Entra para o DAB.

Limpa os recursos do Azure e o registo da aplicação quando terminares.

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

O fluxo de limpeza executa o script de desmantelamento do Microsoft Entra. Se precisares de remover o registo da aplicação separadamente, executa azure-infra/entra-teardown.ps1 no exemplo.

Ficheiros-chave

Path Purpose
data-api/dab-config.json Define os papéis do EntraId fornecedor de autenticação, público, emissor e entidade.
aspire-apphost/Demo.cs Verifica marcadores de posição do Microsoft Entra em dab-config.json e orienta a configuração local.
azure-infra/entra-setup.ps1 Cria ou configura o registo da aplicação e a audiência da API.
azure-infra/entra-teardown.ps1 Apaga o registo da aplicação durante a desmontagem.
web-app/index.html, web-app/app.js, web-app/dab.js, web-app/config.js Ficheiros Web estáticos que se mantêm anónimos e não usam o MSAL.

Usa o GitHub Copilot para recriar este exemplo

Abre o espaço de trabalho onde queres criar o exemplo no Visual Studio Code, muda o GitHub Copilot para o modo agente e cola este prompt.

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.

Conteúdo relacionado

  • Last updated on