データ ソース

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

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

消費 SESSION_CONTEXT

Azure SQL および SQL Server の場合、データ API ビルダーは 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;

例: 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')"
}

接続の弾力性

データ API ビルダーは、指数バックオフを使用して、一時的なエラーの後にデータベース要求を再試行します。

マネージド サービス ID (MSI)

マネージド サービス ID (MSI) は、DefaultAzureCredential ライブラリで定義されているAzure.Identityでサポートされています。 Microsoft Entra for Azure SQL のマネージド ID の詳細について説明します。

User-Assigned マネージド ID (UAMI)

ユーザー割り当てマネージド ID の場合は、ユーザー割り当てマネージド ID のクライアント IDAuthentication=Active Directory Managed Identity; User Id=<UMI_CLIENT_ID>;に置き換えながら、認証とユーザー ID のプロパティを接続文字列に追加します。

System-Assigned マネージド ID (SAMI)

システム割り当てマネージド ID の場合は、Authentication プロパティを追加し、接続文字列 (Authentication=Active Directory Managed Identity;) から UserId 引数と Password 引数を除外します。

正常性 (データ ソース)

データ API ビルダーでは、複数の構成ファイルがサポートされ、それぞれに独自のデータ ソースが含まれています。 この構成ブロックを使用すると、各データ ソースに独自の正常性構成を設定できます。

入れ子になったプロパティ

名前を確認する

複数の構成ファイルが同じ種類のデータ ソースを指している可能性があるため、正常性レポートではそれらのデータ ソースを区別できません。 nameを使用して、正常性レポートでのみ使用される一意の識別可能なラベルを割り当てます。

動作を確認する

データベースの種類に固有の最も単純なクエリは、指定されたデータ ソースに対して実行され、接続を開くことができることを検証します。 threshold-ms プロパティを使用して、そのクエリが完了するまでの最大許容期間 (ミリ秒単位) を構成します。

Format

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

ユーザー委任認証

SQL Server と Azure SQL のオンBehalf-Of (OBO) ユーザー委任認証。 有効にすると、DAB は受信ユーザー トークンをダウンストリーム SQL トークンと交換し、データベースが実際の呼び出し元ユーザーとして認証されるようにします。 この機能は、 mssql データ ソースでのみサポートされており、アップストリームで Entra ID 認証が必要です。

入れ子になったプロパティ

• enabled—OBO のオンとオフを切り替えます。
• provider—トークン交換の ID プロバイダー。 現在、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"
    }
  }
}