Démarrage rapide : Utiliser une identité managée avec le générateur d’API de données

Dans ce guide de démarrage rapide, vous utilisez l’exemple d’identité managée Quickstart 2 pour exécuter le générateur d’API de données (DAB) avec un accès sans mot de passe à Azure SQL. L’exemple utilise l’accès anonyme de l’utilisateur à l’application web, l’accès anonyme de l’application web à DAB et une identité managée affectée par le système de DAB à Azure SQL.

L’exemple expose des données SQL via REST, GraphQL et MCP. Il inclut également .NET Aspire orchestration locale et les scripts de déploiement Azure.

Important

Le chemin local peut utiliser l’authentification SQL comme secours de développement. Le chemin d’accès Azure utilise l’identité managée et n’a pas de mot de passe SQL dans la configuration DAB.

Prerequisites

  • .NET 8 ou version ultérieure
  • Docker Desktop
  • Powershell
  • outils .NET Aspire pour l’orchestration locale
  • Azure CLI pour le déploiement Azure
  • sqlpackage si vous déployez le projet de base de données
  • Un abonnement Azure avec l’autorisation de créer des Azure SQL, des Azure Container Apps, des Azure Container Registry, des Log Analytics et un groupe de ressources
  • Un utilisateur ou un groupe Microsoft Entra qui peut devenir l’administrateur Microsoft Entra d’Azure SQL

Présentation de l’exemple

  • Application web statique qui appelle DAB sans connexion utilisateur.
  • DAB configuré comme la seule couche d’API, de GraphQL et de MCP sur SQL.
  • Authentification SQL de DAB vers le conteneur de développement SQL Server local.
  • Accès DAB sans mot de passe à Azure SQL via une identité managée affectée par le système.
  • Azure SQL configuré avec un administrateur Microsoft Entra.
  • Utilisateur de base de données autonome créé pour l’identité managée DAB.
  • db_datareader et db_datawriter attributions de rôles pour l’identité DAB.
  • .NET Aspire orchestration pour les SQL Server locaux, DAB, l’application web, SQL Commander et l’inspecteur MCP.
  • Déploiement et nettoyage d’Azure à l’aide de scripts PowerShell dans azure-infra.

Flux d’authentification

Hop Authentification locale Authentification d'Azure
De l’utilisateur vers l’application web Anonyme Anonyme
Application web vers l’API Anonyme Anonyme
API vers SQL Authentification SQL Identité gérée attribuée par le système

Comparer avec la série

Step Modifications apportées
Previous Utiliser l’authentification SQL stocke des informations d’identification SQL pour l’accès de DAB à SQL.
Ce démarrage rapide Supprime le mot de passe Azure SQL à l’aide d’une identité managée affectée par le système.
Suivant Ajouter un fournisseur Microsoft Entra configure la validation des jetons tout en conservant l’accès anonyme à l’API.

Utiliser l’exemple

Clonez l’exemple de référentiel.

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

Exécutez l’exemple localement.

dotnet tool restore
dotnet run --project aspire-apphost

Le tableau de bord Aspire s’ouvre à l’adresse http://localhost:15888. L’application web s’ouvre à l’adresse http://localhost:5173. Utilisez le tableau de bord pour inspecter le point de terminaison DAB, SQL Server conteneur, l’inspecteur MCP et les ressources SQL Commander.

Déployez l’exemple sur Azure.

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

Le script de déploiement provisionne des ressources Azure SQL et Azure Container Apps pour DAB, l’application web, l’inspecteur MCP et SQL Commander. Il définit également l’application conteneur DAB pour utiliser une identité managée affectée par le système et configure un Azure SQL chaîne de connexion sans mot de passe mis en forme comme cet exemple.

Server=tcp:<sql-server>.database.windows.net,1433;Database=<database>;Authentication=Active Directory Default;Encrypt=True;TrustServerCertificate=False;

Le script post-approvisionnement définit l’administrateur Azure SQL Microsoft Entra, crée un utilisateur de base de données autonome pour l’identité managée DAB et accorde db_datareader et db_datawriter.

Nettoyez Azure ressources lorsque vous avez terminé.

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

Fichiers clés

Chemin Purpose
azure-infra/resources.bicep Définit les ressources Azure, active l’identité SystemAssigned sur l’application conteneur DAB et définit la chaîne de connexion sans mot de passe à Azure SQL.
azure-infra/main.bicep Orchestre le déploiement et génère l’ID principal de l’application conteneur DAB.
azure-infra/post-provision.ps1 Définit l’administrateur Azure SQL Microsoft Entra, crée l’utilisateur de base de données autonome pour l’identité DAB et accorde des rôles de base de données.
data-api/dab-config.json Configuration du runtime DAB pour SQL, REST, GraphQL, MCP et l’accès anonyme aux entités.
database Projet de base de données SQL, fichiers de schéma et scripts de données initiales.
web-app Application web statique qui appelle DAB anonymement.
aspire-apphost .NET Aspire AppHost qui orchestre les conteneurs locaux et les ressources de projet.

Utilisez GitHub Copilot pour recréer cet exemple

Ouvrez l’espace de travail dans lequel vous souhaitez créer l’exemple dans Visual Studio Code, basculez GitHub Copilot en mode agent, puis collez cette invite.

You are GitHub Copilot running in agent mode. Recreate the Data API builder Quickstart 2 Managed Identity sample as a complete, runnable project in the current VS Code workspace under `quickstart-02-managed-identity`. Build a static web app, DAB, local SQL Server with SQL authentication for development, Azure SQL with system-assigned managed identity for Azure, 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.

Source repository: https://github.com/Azure-Samples/dab-2.0-quickstart-web_anon-api_anon-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, and resource group should Azure deployment use? Default fallback region: `westus2` if the primary region can't provision Azure SQL or Container Apps.
- Which Microsoft Entra user or group should become the Azure SQL Microsoft Entra admin?
- Do you approve creating billable Azure resources if the deployment phase starts?

After the answers, show a checklist and ask for approval before implementation. Include phases for local scaffold, local validation, Azure infrastructure, managed identity database grants, Azure validation, and cleanup. Do not run any Azure command that creates or changes 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. 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, `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

Create this structure under the sample folder:

- `azure-infra/` for Bicep, `azure-up.ps1`, `azure-down.ps1`, and `post-provision.ps1`.
- `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 HTML, CSS, and JavaScript that calls DAB anonymously.
- `aspire-apphost/` for the .NET Aspire AppHost.
- `mcp-inspector/` for MCP Inspector notes or container assets.

Handle secrets first. Add `.env`, `**/bin`, and `**/obj` to `.gitignore` before writing secrets. Use `MSSQL_CONNECTION_STRING` locally. Never print secret values. Use `@env('MSSQL_CONNECTION_STRING')` in local `dab-config.json`.

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')" --host-mode Development --rest.enabled true --graphql.enabled true --mcp.enabled true
dab add Todos --source dbo.Todos --source.type table --permissions "anonymous:read" --mcp.dml-tools true
dab validate --config data-api/dab-config.json
```

Use this Azure SQL connection string shape for the Azure Container App. The Azure DAB configuration must not contain `User ID=` or `Password=`.

```text
Server=tcp:<sql-server>.database.windows.net,1433;Database=<database>;Authentication=Active Directory Default;Encrypt=True;TrustServerCertificate=False;
```

Enable system-assigned identity on the DAB Container App and output its principal ID for post-provisioning.

```bicep
identity: {
  type: 'SystemAssigned'
}
```

In post-provisioning, set the Azure SQL Microsoft Entra admin, deploy the schema, create a contained database user for the DAB managed identity, and grant least required database roles.

```sql
CREATE USER [<dab-container-app-name>] FROM EXTERNAL PROVIDER;
ALTER ROLE db_datareader ADD MEMBER [<dab-container-app-name>];
ALTER ROLE db_datawriter ADD MEMBER [<dab-container-app-name>];
```

Use these Aspire patterns from the quickstart skills. Use `.WaitForCompletion(sqlDatabaseProject)` for DAB and SQL Commander when a SQL project deploys schema.

```csharp
var sqlDatabaseProject = builder.AddSqlProject<Projects.database>("sql-project")
	.WithReference(sqlDatabase);

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)
	.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, 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
```

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.
- Aspire shows SQL Server, DAB, SQL Commander, and MCP Inspector healthy.
- 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.
- REST, GraphQL, and MCP return seeded data anonymously.
- 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.
- In Azure, the DAB Container App has a system-assigned managed identity.
- In Azure, the connection string contains `Authentication=Active Directory Default` and contains no `User ID=` or `Password=`.
- The DAB managed identity exists as a contained database user with `db_datareader` and `db_datawriter`.

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.

Contenu connexe

  • Last updated on