Origen de datos

En la sección se data-source definen los detalles del acceso a la base de datos. También define las opciones de la base de datos.

Configuración del origen de datos

Introducción al formato

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

Origen de datos

Propiedades anidadas

Valores de propiedad

Format

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

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

Consumir SESSION_CONTEXT

Para Azure SQL y SQL Server, el generador de API de datos puede incluir información de notificaciones en 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;

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

Variables de entorno

Use variables de entorno para mantener los secretos de texto sin formato del archivo de configuración.

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

Resistencia de la conexión

Data API Builder usa retroceso exponencial para reintentar las solicitudes de base de datos después de errores transitorios.

Identidades de servicio administradas (MSI)

Las identidades de servicio administradas (MSI) se admiten con DefaultAzureCredential definidas en Azure.Identity la biblioteca. Obtenga más información sobre las identidades administradas en Microsoft Entra para Azure SQL.

User-Assigned identidades administradas (UAMI)

En Identidad administrada asignada por el usuario, anexe las propiedades Autenticación e Identificador de usuario a la cadena de conexión al sustituir en el identificador de cliente de la identidad administrada asignada por el usuario: Authentication=Active Directory Managed Identity; User Id=<UMI_CLIENT_ID>;.

identidad administrada de System-Assigned (SAMI)

En Identidad administrada asignada por el sistema, anexe la propiedad Authentication y excluya los argumentos UserId y Password de la cadena de conexión: Authentication=Active Directory Managed Identity;.

Estado (origen de datos)

Data API Builder admite varios archivos de configuración, cada uno con su propio origen de datos. Este bloque de configuración permite que cada origen de datos tenga su propia configuración de estado.

Propiedades anidadas

Comprobar nombre

Dado que varios archivos de configuración pueden apuntar a orígenes de datos del mismo tipo, esos orígenes de datos no se pueden distinguir en el informe de estado. Use name para asignar una etiqueta única y identificable que solo se usa en el informe de mantenimiento.

Comprobación del comportamiento

La consulta más sencilla posible,específica del tipo de base de datos, se ejecuta en el origen de datos especificado para validar que se puede abrir la conexión. Use la threshold-ms propiedad para configurar la duración máxima aceptable (en milisegundos) para que se complete esa consulta.

Format

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

Autenticación delegada por el usuario

Autenticación delegada por el usuario enBehalf-Of (OBO) para SQL Server y Azure SQL. Cuando está habilitada, DAB intercambia el token de usuario entrante para un token SQL de nivel inferior para que la base de datos se autentique como el usuario que realiza la llamada real. Esta característica solo se admite para mssql orígenes de datos y requiere la autenticación de Entra ID ascendente.

Propiedades anidadas

• enabled— activa o desactiva OBO.
• provider: el proveedor de identidades para el intercambio de tokens. Actualmente solo se admite EntraId.
• database-audience: la audiencia de destino para el token de SQL de bajada (por ejemplo, https://database.windows.net).

Variables de entorno necesarias

Cuando OBO está habilitado, DAB lee las siguientes variables de entorno para el intercambio de tokens:

Agrupación de conexiones por usuario

Cuando OBO está habilitado, DAB mantiene grupos de conexiones SQL independientes por usuario para que el token de acceso de un usuario nunca se reutilice para la solicitud de otro usuario.

Format

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

Ejemplo

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