Vue d’ensemble des API de table OneLake

OneLake fournit des API pour travailler avec les métadonnées de table et lire les lignes de tableaux dans Fabric. Les API de métadonnées de catalogue fonctionnent avec des clients et des bibliothèques compatibles avec la norme ouverte de l’API Iceberg REST Catalog (IRC) ou la norme ouverte de l’API Unity Catalog. Une API REST courante lit et écrit des descriptions et balises supplémentaires pour les tables et colonnes. L’API de lecture de table indépendante du format renvoie les lignes de table comme des données Apache Arrow tout en appliquant la sécurité OneLake.

Travailler avec les métadonnées de table

Utilisez les API de métadonnées pour découvrir les schémas, tables et métadonnées de tables. Les opérations de lecture et d’écriture prises en charge varient selon le protocole.

Utilisez l’API de métadonnées supplémentaires de table (aperçu) pour lire et écrire les descriptions et balises de tables, colonnes sans utiliser d’API de catalogue spécifique à chaque format.

API Protocol Formats de tableau
API de métadonnées Iceberg API du catalogue REST d’Iceberg Métadonnées Iceberg des tables OneLake prises en charge
API de métadonnées Delta API REST compatible avec Unity Catalog Métadonnées Delta

Lire les données du tableau

Utilisez l’API de lecture de tables pour récupérer les lignes sécurisées des tables OneLake prises en charge.

API Protocole et flux de travail Formats de tableau
API de lecture de table (aperçu) Allouer des flux avec POST /read, et récupérer chaque flux avec GET /readStream/{streamId} Tables valides pour les lacs Delta et les icebergs Apache

Prerequisites

Avant d’utiliser ces API, identifiez quelques informations et sélectionnez votre flux d’authentification Microsoft Entra ID préféré.

Rassemblez des informations de base

Rassemblez les informations suivantes :

  • VOTRE ID de locataire Fabric.

    L’identifiant du locataire est un GUID. Trouvez-le dans la carte de profil ou dans l’aide>à propos de Fabric.

  • L’espace de travail et l’ID d’élément de données de l’élément de données (par exemple, un lakehouse) avec un répertoire Tables de niveau supérieur.

    Ces ID sont des GUID (Identifiants Globaux Uniques). Elles se trouvent dans l’URL OneLake de n’importe quelle table dans OneLake. Vous pouvez également les trouver dans l’URL affichée dans votre navigateur lorsque vous disposez d’un élément de données ouvert dans Fabric.

  • Le nom du schéma et le nom de la table que vous souhaitez consulter. Pour l’API de lecture de table, la table doit être une table valide de Delta Lake ou Apache Iceberg.

  • Une identité d’utilisateur ou de principal de service dans Microsoft Entra ID qui possède les permissions requises pour les opérations que vous envisagez d’utiliser.

    • Les opérations de lecture nécessitent une autorisation pour lire les tables cibles. L’API de lecture de table utilise les permissions et les politiques de sécurité des données pour cette identité lorsqu’elle retourne des lignes et des colonnes.
    • Les opérations d’écriture nécessitent un accès en écriture à l’élément de données cible et à l’emplacement OneLake. Selon le type d’élément et le modèle d’accès, accorder un rôle d’élément ou d’espace de travail permettant d’écrire, ou accorder ReadWrite via un rôle d’accès aux données OneLake. Pour plus d’informations, consultez Prise en main de la sécurité OneLake.

Préparez-vous à l’authentification

Élaborez un plan pour la façon dont vous souhaitez vous authentifier avec l’API.

  1. Décidez de la façon dont vous souhaitez vous authentifier auprès de Microsoft Entra ID pour obtenir un jeton d’accès pour votre identité Microsoft Entra choisie.

    Vous pouvez consulter ce guide pour en savoir plus sur les différentes façons d’obtenir un jeton d’accès avec l’ID Microsoft Entra. Microsoft propose des bibliothèques d’authentification pratiques dans plusieurs langues.

  2. Si vous développez une nouvelle application qui permettra aux utilisateurs de se connecter ou de se connecter en tant qu’application autonome, inscrivez votre application avec l’ID Microsoft Entra.

  3. Accordez l’autorisation d’API pour l’audience du jeton Stockage Azure (https://storage.azure.com/) à votre application Microsoft Entra ID. L’octroi de cette autorisation garantit que votre application peut obtenir des jetons à utiliser avec le point de terminaison de la table OneLake.

    Note

    Le point de terminaison de l'API de table OneLake accepte la même audience de jeton que les points de terminaison du système de fichiers OneLake.

    Si vous développez une application, vous savez peut-être déjà comment vous authentifier avec Microsoft Entra ID pour interagir avec les API REST du système de fichiers OneLake. Si oui, vous pouvez utiliser la même méthode pour authentifier avec le point de terminaison de la table OneLake.