Gegevensbron

In data-source de sectie worden de details van de databasetoegang gedefinieerd. Er worden ook databaseopties gedefinieerd.

Gegevensbroninstellingen

Overzicht van opmaak

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

Gegevensbron

Geneste eigenschappen

Vastgoedwaarden

Format

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

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

Consumeren SESSION_CONTEXT

Voor Azure SQL en SQL Server kan Data API Builder claimgegevens bevatten 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;

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

Omgevingsvariabelen

Gebruik omgevingsvariabelen om geheimen zonder opmaak buiten uw configuratiebestand te houden.

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

Verbindingstolerantie

Data API Builder maakt gebruik van Exponential Backoff om databaseaanvragen opnieuw uit te voeren na tijdelijke fouten.

Managed Service Identities (MSI)

Managed Service Identities (MSI) worden ondersteund met DefaultAzureCredential gedefinieerde bibliotheek Azure.Identity . Meer informatie over beheerde identiteiten in Microsoft Entra voor Azure SQL.

User-Assigned Beheerde identiteiten (UAMI)

Voor door de gebruiker toegewezen beheerde identiteit voegt u de eigenschappen verificatie en gebruikers-id toe aan uw verbindingsreeks terwijl u de client-id van de door de gebruiker toegewezen beheerde identiteit vervangt: Authentication=Active Directory Managed Identity; User Id=<UMI_CLIENT_ID>;.

System-Assigned Managed Identity (SAMI)

Voor door het systeem toegewezen beheerde identiteit voegt u de eigenschap Verificatie toe en sluit u de argumenten UserId en Wachtwoord uit van de verbindingsreeks: Authentication=Active Directory Managed Identity;.

Status (gegevensbron)

Data API Builder ondersteunt meerdere configuratiebestanden, elk met een eigen gegevensbron. Met dit configuratieblok kan elke gegevensbron een eigen statusconfiguratie hebben.

Geneste eigenschappen

Naam controleren

Omdat meerdere configuratiebestanden naar gegevensbronnen van hetzelfde type kunnen verwijzen, kunnen deze gegevensbronnen niet worden onderscheiden in het statusrapport. Gebruik name dit om een uniek, identificeerbaar label toe te wijzen dat alleen in het statusrapport wordt gebruikt.

Gedrag controleren

De eenvoudigste query, specifiek voor het databasetype, wordt uitgevoerd op basis van de opgegeven gegevensbron om te controleren of de verbinding kan worden geopend. Gebruik de threshold-ms eigenschap om de maximaal acceptabele duur (in milliseconden) voor die query te configureren.

Format

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

Door de gebruiker gedelegeerde verificatie

On-Behalf-Of (OBO) door de gebruiker gedelegeerde verificatie voor SQL Server en Azure SQL. Indien ingeschakeld, wisselt DAB het binnenkomende gebruikerstoken uit voor een downstream SQL-token, zodat de database wordt geverifieerd als de werkelijke aanroepende gebruiker. Deze functie wordt alleen ondersteund voor mssql gegevensbronnen en vereist upstream-verificatie van Entra-id's.

Geneste eigenschappen

• enabled— schakelt OBO in of uit.
• provider— de id-provider voor de tokenuitwisseling. Momenteel wordt alleen EntraId ondersteund.
• database-audience— de doelgroep voor het downstream SQL-token (bijvoorbeeld https://database.windows.net).

Vereiste omgevingsvariabelen

Wanneer OBO is ingeschakeld, leest DAB de volgende omgevingsvariabelen voor de tokenuitwisseling:

Groepsgewijze verbindingen per gebruiker

Wanneer OBO is ingeschakeld, onderhoudt DAB afzonderlijke SQL-verbindingsgroepen per gebruiker, zodat het toegangstoken van één gebruiker nooit opnieuw wordt gebruikt voor de aanvraag van een andere gebruiker.

Format

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

Voorbeeld

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