Datakälla

Avsnittet data-source definierar information om databasåtkomst. Den definierar även databasalternativ.

Inställningar för datakälla

Formatöversikt

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

Datakälla

Kapslade egenskaper

Egenskapsvärden

Format

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

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

Konsumera SESSION_CONTEXT

För Azure SQL och SQL Server kan Data API-byggare inkludera anspråksinformation i SQL:s 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;

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

Miljövariabler

Använd miljövariabler för att hålla oformaterade texthemligheter borta från konfigurationsfilen.

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

Anslutningsmotståndskraft

Data API Builder använder exponentiell backoff för att försöka databasbegäranden igen efter tillfälliga fel.

Hanterade tjänstidentiteter (MSI)

Hanterade tjänstidentiteter (MSI) stöds med DefaultAzureCredential definierade i Azure.Identity biblioteket. Läs mer om hanterade identiteter i Microsoft Entra för Azure SQL.

User-Assigned hanterade identiteter (UAMI)

För Användartilldelad hanterad identitet lägger du till egenskaperna Autentisering och Användar-ID i anslutningssträngen medan du ersätter i klient-ID:t för den användartilldelade hanterade identiteten: Authentication=Active Directory Managed Identity; User Id=<UMI_CLIENT_ID>;.

System-Assigned hanterad identitet (SAMI)

För Systemtilldelad hanterad identitet lägger du till egenskapen Autentisering och exkluderar argumenten UserId och Lösenord från anslutningssträngen: Authentication=Active Directory Managed Identity;.

Hälsa (datakälla)

Data API Builder stöder flera konfigurationsfiler, var och en med sin egen datakälla. Med det här konfigurationsblocket kan varje datakälla ha en egen hälsokonfiguration.

Kapslade egenskaper

Kontrollera namn

Eftersom flera konfigurationsfiler kan peka på datakällor av samma typ kan dessa datakällor inte särskiljas i hälsorapporten. Använd name för att tilldela en unik, identifierbar etikett som endast används i hälsorapporten.

Kontrollera beteende

Den enklaste möjliga frågan – specifik för databastypen – körs mot den angivna datakällan för att verifiera att anslutningen kan öppnas. Använd egenskapen threshold-ms för att konfigurera den maximala acceptabla varaktigheten (i millisekunder) för att frågan ska slutföras.

Format

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

Användardelegering

Användardelegering påBehalf-Of (OBO) för SQL Server och Azure SQL. När den är aktiverad byter DAB ut den inkommande användartoken mot en underordnad SQL-token så att databasen autentiseras som den faktiska anropande användaren. Den här funktionen stöds endast för mssql datakällor och kräver Entra-ID-autentisering uppströms.

Kapslade egenskaper

• enabled— aktiverar eller inaktiverar OBO.
• provider– identitetsprovidern för tokenutbytet. För närvarande stöds endast EntraId.
• database-audience– målgruppen för den underordnade SQL-token (till exempel https://database.windows.net).

Obligatoriska miljövariabler

När OBO är aktiverat läser DAB följande miljövariabler för tokenutbytet:

Anslutningspooler per användare

När OBO är aktiverat underhåller DAB separata SQL-anslutningspooler per användare så att en användares åtkomsttoken aldrig återanvänds för en annan användares begäran.

Format

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

Exempel

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