Источник данных

В data-source разделе определяются сведения о доступе к базе данных. Он также определяет параметры базы данных.

Параметры источника данных

Обзор формата

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

Источник данных

Вложенные свойства

Значения свойств

Format

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

Пример: SQL Azure и 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

Для SQL Azure и SQL Server построитель API данных может включать сведения о утверждениях SESSION_CONTEXTв SQL.

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;

Пример: 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"
  }
}

Переменные среды

Используйте переменные среды для сохранения секретов обычного текста из файла конфигурации.

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

Устойчивость подключения

Построитель данных использует экспоненциальную обратную передачу для повторных запросов к базе данных после временных ошибок.

Удостоверения управляемых служб (MSI)

Управляемые удостоверения службы (MSI) поддерживаются в DefaultAzureCredentialAzure.Identity библиотеке. Дополнительные сведения об управляемых удостоверениях в Microsoft Entra для SQL Azure.

User-Assigned управляемых удостоверений (UAMI)

Для управляемого удостоверения, назначаемого пользователем, добавьте свойства проверки подлинности и идентификатора пользователя в строку подключения, подставив идентификатор клиента назначаемого пользователем управляемого удостоверения: Authentication=Active Directory Managed Identity; User Id=<UMI_CLIENT_ID>;

управляемое удостоверение System-Assigned (SAMI)

Для управляемого удостоверения, назначаемого системой, добавьте свойство Authentication и исключите аргументы UserId и Password из строки подключения: Authentication=Active Directory Managed Identity;

Работоспособности (источник данных)

Построитель данных поддерживает несколько файлов конфигурации, каждый из которых имеет собственный источник данных. Этот блок конфигурации позволяет каждому источнику данных иметь собственную конфигурацию работоспособности.

Вложенные свойства

Проверить имя

Так как несколько файлов конфигурации могут указывать на источники данных одного типа, эти источники данных не могут отличаться в отчете о работоспособности. Используется name для назначения уникальной идентифицируемой метки, используемой только в отчете о работоспособности.

Проверка поведения

Самый простой запрос, характерный для типа базы данных, выполняется в заданном источнике данных, чтобы убедиться, что подключение можно открыть. threshold-ms Используйте свойство, чтобы настроить максимальную допустимую длительность (в миллисекундах) для завершения этого запроса.

Format

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

Делегированная пользователем проверка подлинности

Делегированная пользователем проверка подлинности вBehalf-Of (OBO) для SQL Server и Azure SQL. Если этот параметр включен, DAB обменивается входящим маркером пользователя для нижестоящего маркера SQL, чтобы база данных выполняла проверку подлинности в качестве фактического вызывающего пользователя. Эта функция поддерживается только для mssql источников данных и требует вышестоящей проверки подлинности идентификатора записи.

Вложенные свойства

• enabled— включает или отключает OBO.
• provider— поставщик удостоверений для обмена токенами. Поддерживается только EntraId.
• database-audience— целевая аудитория для нижестоящего маркера SQL (например, https://database.windows.net).

Обязательные переменные среды

Если OBO включен, DAB считывает следующие переменные среды для обмена токенами:

Пул подключений для каждого пользователя

Если OBO включен, DAB поддерживает отдельные пулы подключений SQL на пользователя, чтобы маркер доступа одного пользователя никогда не был повторно использован для запроса другого пользователя.

Format

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

Пример

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