Datenquelle

Der data-source Abschnitt definiert die Datenbankzugriffsdetails. Außerdem werden Datenbankoptionen definiert.

Datenquelleneinstellungen

Formatübersicht

{
  "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>"]
}

Datenquelle

Verschachtelte Eigenschaften

Immobilienwerte

Format

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

Beispiel: 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
    }
}

SESSION_CONTEXT verwenden

Für Azure SQL und SQL Server kann der Daten-API-Generator Anspruchsinformationen in SQL enthalten SESSION_CONTEXT.

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;

Beispiel: 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"
  }
}

Umgebungsvariablen

Verwenden Sie Umgebungsvariablen, um geheime Nur-Text-Schlüssel aus Ihrer Konfigurationsdatei zu behalten.

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

Verbindungsstabilität

Der Daten-API-Generator verwendet exponentielles Backoff, um Datenbankanforderungen nach vorübergehenden Fehlern erneut zu versuchen.

Verwaltete Dienstidentitäten (MSI)

Verwaltete Dienstidentitäten (MSI) werden mit DefaultAzureCredential unterstützt, die in der bibliothek Azure.Identity definiert sind. Erfahren Sie mehr über verwaltete Identitäten in Microsoft Entra für Azure SQL.

Vom Benutzer zugewiesene verwaltete Identitäten (UAMI)

Fügen Sie für vom Benutzer zugewiesene verwaltete Identität die Eigenschaften Authentication und Benutzer-ID an Ihre Verbindungszeichenfolge an, während sie die Client-ID Ihrer vom Benutzer zugewiesenen verwalteten Identität ersetzen: Authentication=Active Directory Managed Identity; User Id=<UMI_CLIENT_ID>;.

Vom System zugewiesene verwaltete Identität (SAMI)

Fügen Sie für vom System zugewiesene verwaltete Identität die Eigenschaft Authentication an, und schließen Sie die Argumente UserId und Password aus Ihrem Verbindungszeichenfolge aus: Authentication=Active Directory Managed Identity;.

Integrität (Datenquelle)

Der Daten-API-Generator unterstützt mehrere Konfigurationsdateien, die jeweils über eine eigene Datenquelle verfügen. Mit diesem Konfigurationsblock kann jede Datenquelle über eine eigene Integritätskonfiguration verfügen.

Verschachtelte Eigenschaften

Überprüfen des Namens

Da mehrere Konfigurationsdateien auf Datenquellen desselben Typs verweisen können, können diese Datenquellen im Integritätsbericht nicht unterschieden werden. Dient name zum Zuweisen einer eindeutigen, identifizierbaren Bezeichnung, die nur im Integritätsbericht verwendet wird.

Überprüfen des Verhaltens

Die einfachste abfrage , die für den Datenbanktyp spezifisch ist, wird für die angegebene Datenquelle ausgeführt, um zu überprüfen, ob die Verbindung geöffnet werden kann. Verwenden Sie die threshold-ms Eigenschaft, um die maximal zulässige Dauer (in Millisekunden) für diese Abfrage zu konfigurieren.

Format

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

Benutzerdelegierte Authentifizierung

On-Behalf-Of (OBO) benutzerdelegierte Authentifizierung für SQL Server und Azure SQL. Wenn diese Option aktiviert ist, wechselt DAB das eingehende Benutzertoken für ein nachgeschaltetes SQL-Token, sodass die Datenbank als tatsächlich aufgerufener Benutzer authentifiziert wird. Dieses Feature wird nur für mssql-Datenquellen unterstützt und erfordert Microsoft Entra ID Authentifizierung upstream.

Verschachtelte Eigenschaften

• enabled– aktiviert oder deaktiviert OBO.
• provider– der Identitätsanbieter für den Tokenaustausch. Derzeit wird nur EntraId unterstützt.
• database-audience— die Zielgruppe für das nachgeschaltete SQL-Token (z. B https://database.windows.net. ).

Erforderliche Umgebungsvariablen

Wenn OBO aktiviert ist, liest DAB die folgenden Umgebungsvariablen für den Tokenaustausch:

Pro Benutzerverbindungspooling

Wenn OBO aktiviert ist, verwaltet DAB separate SQL-Verbindungspools pro Benutzer, sodass das Zugriffstoken eines Benutzers nie für die Anforderung eines anderen Benutzers wiederverwendet wird.

Format

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

Beispiel

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