Źródło danych

Sekcja data-source definiuje szczegóły dostępu do bazy danych. Definiuje również opcje bazy danych.

Ustawienia źródła danych

Omówienie formatu

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

Źródło danych

Właściwości zagnieżdżone

Wartości właściwości

Format

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

Przykład: Azure SQL i 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
    }
}

Spożywanie SESSION_CONTEXT

W przypadku usług Azure SQL i SQL Server konstruktor interfejsu API danych może zawierać informacje o oświadczeniach w usługach 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;

Przykład: 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"
  }
}

Zmienne środowiskowe

Użyj zmiennych środowiskowych, aby zachować wpisy tajne zwykłego tekstu z pliku konfiguracji.

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

Odporność połączenia

Konstruktor interfejsu API danych używa wycofywania wykładniczego w celu ponawiania żądań bazy danych po błędach przejściowych.

Tożsamości usługi zarządzanej (MSI)

Tożsamości usługi zarządzanej (MSI) są obsługiwane przez funkcję zdefiniowaną DefaultAzureCredential w Azure.Identity bibliotece. Dowiedz się więcej o tożsamościach zarządzanych w usłudze Microsoft Entra for Azure SQL.

tożsamości zarządzane User-Assigned (UAMI)

W polu Tożsamość zarządzana przypisana przez użytkownika dołącz właściwości Authentication (Uwierzytelnianie ) i User ID (Identyfikator użytkownika) do parametrów połączenia podczas zastępowania identyfikatora klienta tożsamości zarządzanej przypisanej przez użytkownika: Authentication=Active Directory Managed Identity; User Id=<UMI_CLIENT_ID>;.

tożsamość zarządzana System-Assigned (SAMI)

W polu Tożsamość zarządzana przypisana przez system dołącz właściwość Authentication i wyklucz argumenty UserId i Password z parametrów połączenia: Authentication=Active Directory Managed Identity;.

Kondycja (źródło danych)

Konstruktor interfejsu API danych obsługuje wiele plików konfiguracji, z których każdy ma własne źródło danych. Ten blok konfiguracji umożliwia każdemu źródle danych posiadanie własnej konfiguracji kondycji.

Właściwości zagnieżdżone

Sprawdź nazwę

Ponieważ wiele plików konfiguracji może wskazywać źródła danych tego samego typu, te źródła danych nie mogą być rozróżniane w raporcie kondycji. Służy name do przypisywania unikatowej, możliwej do zidentyfikowania etykiety używanej tylko w raporcie kondycji.

Sprawdzanie zachowania

Najprostsze możliwe zapytanie — specyficzne dla typu bazy danych — jest wykonywane względem danego źródła danych w celu sprawdzenia, czy połączenie można otworzyć. threshold-ms Użyj właściwości , aby skonfigurować maksymalny dopuszczalny czas trwania (w milisekundach) dla tego zapytania do ukończenia.

Format

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

Uwierzytelnianie delegowane przez użytkownika

Uwierzytelnianie delegowane przez użytkownika wBehalf-Of (OBO) dla programu SQL Server i usługi Azure SQL. Po włączeniu język DAB wymienia token użytkownika przychodzącego dla podrzędnego tokenu SQL, aby baza danych uwierzytelniła się jako rzeczywisty użytkownik wywołujący. Ta funkcja jest obsługiwana tylko w przypadku mssql źródeł danych i wymaga uwierzytelniania entra ID nadrzędnego.

Właściwości zagnieżdżone

• enabled— włącza lub wyłącza funkcję OBO.
• provider— dostawca tożsamości dla wymiany tokenów. Obecnie obsługujemy tylko EntraId.
• database-audience— docelowy odbiorca tokenu SQL podrzędnego (na przykład https://database.windows.net).

Wymagane zmienne środowiskowe

Po włączeniu funkcji OBO usługa DAB odczytuje następujące zmienne środowiskowe dla wymiany tokenów:

Buforowanie połączeń poszczególnych użytkowników

Gdy funkcja OBO jest włączona, usługa DAB utrzymuje oddzielne pule połączeń SQL na użytkownika, dzięki czemu token dostępu jednego użytkownika nigdy nie jest ponownie używany dla żądania innego użytkownika.

Format

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

Przykład

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