L'origine dei dati

La data-source sezione definisce i dettagli di accesso al database. Definisce anche le opzioni di database.

Impostazioni origine dati

Panoramica del formato

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

L'origine dei dati

Proprietà annidate

Valori delle proprietà

Format

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

Esempio: SQL di Azure e 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
    }
}

Consumare SESSION_CONTEXT

Per SQL di Azure e SQL Server, Il generatore di API dati può includere le informazioni sulle attestazioni in SQL 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;

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

Variabili di ambiente

Usare le variabili di ambiente per mantenere i segreti di testo normale all'esterno del file di configurazione.

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

Resilienza della connessione

Il generatore di API dati usa il backoff esponenziale per ripetere le richieste di database dopo errori temporanei.

Identità del servizio gestito

Le identità del servizio gestito sono supportate con DefaultAzureCredential la libreria definita.Azure.Identity Altre informazioni sulle identità gestite in Microsoft Entra per SQL di Azure.

identità gestite User-Assigned (UAMI)

Per Identità gestita assegnata dall'utente, aggiungere le proprietà Autenticazione e ID utente alla stringa di connessione sostituendo l'ID client dell'identità gestita assegnata dall'utente: Authentication=Active Directory Managed Identity; User Id=<UMI_CLIENT_ID>;.

identità gestita System-Assigned (SAMI)

Per Identità gestita assegnata dal sistema, aggiungere la proprietà Authentication ed escludere gli argomenti UserId e Password dalla stringa di connessione: Authentication=Active Directory Managed Identity;.

Integrità (origine dati)

Il generatore di API dati supporta più file di configurazione, ognuno con la propria origine dati. Questo blocco di configurazione consente a ogni origine dati di avere una propria configurazione di integrità.

Proprietà annidate

Controlla nome

Poiché più file di configurazione possono puntare a origini dati dello stesso tipo, tali origini dati non possono essere distinte nel report sull'integrità. Usare name per assegnare un'etichetta univoca e identificabile usata solo nel report sull'integrità.

Controllare il comportamento

La query più semplice possibile, specifica del tipo di database, viene eseguita sull'origine dati specificata per verificare che la connessione possa essere aperta. Utilizzare la threshold-ms proprietà per configurare la durata massima accettabile (in millisecondi) per il completamento della query.

Format

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

Autenticazione delegata dall'utente

Autenticazione delegata dall'utente on-Behalf-Of (OBO) per SQL Server e Azure SQL. Se abilitata, DAB scambia il token utente in ingresso per un token SQL downstream in modo che il database esegua l'autenticazione come utente chiamante effettivo. Questa funzionalità è supportata solo per le mssql origini dati e richiede l'autenticazione di Entra ID upstream.

Proprietà annidate

• enabled— attiva o disattiva OBO.
• provider: provider di identità per lo scambio di token. Attualmente è supportato solo EntraId.
• database-audience: il gruppo di destinatari per il token SQL downstream (ad esempio, https://database.windows.net).

Variabili di ambiente obbligatorie

Quando OBO è abilitato, DAB legge le variabili di ambiente seguenti per lo scambio di token:

Pool di connessioni per utente

Quando OBO è abilitato, DAB gestisce pool di connessioni SQL separati per utente in modo che il token di accesso di un utente non venga mai riutilizzato per la richiesta di un altro utente.

Format

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

Esempio

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