Source de données

La data-source section définit les détails de l’accès à la base de données. Il définit également les options de base de données.

Paramètres de la source de données

Vue d’ensemble du format

{
  "data-source": {
    "database-type": <string>,
    "connection-string": <string>,
    "options": {
      // mssql only
      "set-session-context": <true> (default) | <false>,
      // cosmosdb_nosql only
      "database": <string>,
      "container": <string>,
      "schema": <string>
    },
    "health": {
      "enabled": <true> (default) | <false>,
      "name": <string>,
      "threshold-ms": <integer; default: 1000>
    },
    "user-delegated-auth": {
      "enabled": <true> | <false> (default),
      "provider": <string>,
      "database-audience": <string>
    }
  },
  "data-source-files": ["<string>"]
}

Source de données

Propriétés imbriquées

Valeurs de propriété

Format

{
  "data-source": {
    "database-type": <string>,
    "connection-string": <string>,
    "options": {
      "<key-name>": <string>
    }
  }
}

Exemple : Azure SQL &SQL Server

"data-source": {
  "database-type": "mssql",
  "connection-string": "Server=tcp:myserver.database.windows.net,1433;Initial Catalog=MyDatabase;User ID=MyUser;Password=MyPassword;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;",
    "options": {
      "set-session-context": true
    }
}

Consommer SESSION_CONTEXT

Pour Azure SQL et SQL Server, le générateur d’API de données peut inclure des informations sur les revendications dans les fichiers SESSION_CONTEXTSQL.

CREATE PROC GetUser @userId INT AS
BEGIN
    -- Use claims
    IF SESSION_CONTEXT(N'user_role') = 'admin' 
    BEGIN
        RAISERROR('Unauthorized access', 16, 1);
    END

    SELECT Id, Name, Age, IsAdmin
    FROM Users
    WHERE Id = @userId;
END;

Exemple : Azure Cosmos DB

"data-source": {
  "database-type": "cosmosdb_nosql",
  "connection-string": "@env('SQL_CONNECTION_STRING')",
  "options": {
    "database": "Your_CosmosDB_Database_Name",
    "container": "Your_CosmosDB_Container_Name",
    "schema": "Path_to_Your_GraphQL_Schema_File"
  }
}

Variables d'environnement

Utilisez des variables d’environnement pour empêcher les secrets de texte brut de votre fichier de configuration.

"data-source": {
  "database-type": "mssql",
  "connection-string": "@env('SQL_CONNECTION_STRING')"
}

Résilience des connexions

Le générateur d’API de données utilise l’interruption exponentielle pour réessayer les demandes de base de données après des erreurs temporaires.

Identités de service managées (MSI)

Les identités de service managé (MSI) sont prises en charge avec DefaultAzureCredential définies dans la Azure.Identity bibliothèque. En savoir plus sur les identités managées dans Microsoft Entra pour Azure SQL.

identités managées User-Assigned (UAMI)

Pour l’identité managée affectée par l’utilisateur, ajoutez les propriétés d’authentification et d’ID utilisateur à votre chaîne de connexion tout en remplaçant l’ID client de votre identité managée affectée par l’utilisateur : Authentication=Active Directory Managed Identity; User Id=<UMI_CLIENT_ID>;.

System-Assigned Managed Identity (SAMI)

Pour l’identité managée affectée par le système, ajoutez la propriété d’authentification et excluez les arguments UserId et Password de votre chaîne de connexion : Authentication=Active Directory Managed Identity;.

Intégrité (source de données)

Le générateur d’API de données prend en charge plusieurs fichiers de configuration, chacun avec sa propre source de données. Ce bloc de configuration permet à chaque source de données d’avoir sa propre configuration d’intégrité.

Propriétés imbriquées

Vérifier le nom

Étant donné que plusieurs fichiers de configuration peuvent pointer vers des sources de données du même type, ces sources de données ne peuvent pas être distinguées dans le rapport d’intégrité. Permet name d’attribuer une étiquette unique et identifiable utilisée uniquement dans le rapport d’intégrité.

Vérifier le comportement

La requête la plus simple, propre au type de base de données, est exécutée sur la source de données donnée pour vérifier que la connexion peut être ouverte. Utilisez la threshold-ms propriété pour configurer la durée maximale acceptable (en millisecondes) pour que cette requête se termine.

Format

{
  "data-source": {
    "health": {
      "enabled": <true> (default) | <false>,
      "name": <string>,
      "threshold-ms": <integer; default: 1000>
    }
  }
}

Authentification déléguée par l’utilisateur

Authentification déléguée par l’utilisateur surBehalf-Of (OBO) pour SQL Server et Azure SQL. Lorsqu’il est activé, DAB échange le jeton utilisateur entrant pour un jeton SQL en aval afin que la base de données s’authentifie en tant qu’utilisateur appelant réel. Cette fonctionnalité est prise en charge uniquement pour mssql les sources de données et nécessite l’authentification entra ID en amont.

Propriétés imbriquées

• enabled— active ou désactive OBO.
• provider: fournisseur d’identité pour l’échange de jetons. Actuellement, seul EntraId est pris en charge.
• database-audience— audience cible pour le jeton SQL en aval (par exemple, https://database.windows.net).

Variables d’environnement requises

Lorsque OBO est activé, DAB lit les variables d’environnement suivantes pour l’échange de jetons :

Regroupement de connexions par utilisateur

Lorsque OBO est activé, DAB gère des pools de connexions SQL distincts par utilisateur afin que le jeton d’accès d’un utilisateur ne soit jamais réutilisé pour la demande d’un autre utilisateur.

Format

{
  "data-source": {
    "database-type": "mssql",
    "connection-string": "@env('SQL_CONNECTION_STRING')",
    "user-delegated-auth": {
      "enabled": <true> | <false> (default),
      "provider": <string>,
      "database-audience": <string>
    }
  }
}

Exemple

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