Visão geral das APIs de tabela do OneLake

O OneLake fornece APIs para trabalhar com metadados de tabelas e ler linhas de tabelas no Fabric. As APIs de metadados de catálogo funcionam com clientes e bibliotecas que são compatíveis com o padrão aberto da API Iceberg REST Catalog (IRC) ou com o padrão aberto da API Unity Catalog. Uma API REST comum lê e escreve descrições e etiquetas adicionais para tabelas e colunas. A API de leitura de tabelas independente do formato devolve as linhas das tabelas como dados do Apache Arrow, ao mesmo tempo que aplica a segurança do OneLake.

Trabalhar com metadados de tabela

Utilize as APIs de metadados para descobrir esquemas, tabelas e metadados das tabelas. As operações de leitura e escrita suportadas variam consoante o protocolo.

Utilize a API adicional de metadados de tabelas (pré-visualização) para ler e escrever descrições e etiquetas de tabelas e colunas sem usar uma API de catálogo específica para cada formato.

API Protocolo Formatos de tabelas
API de metadados Iceberg API do catálogo REST do Iceberg Metadados Iceberg das tabelas OneLake suportadas
API de metadados Delta API REST compatível com o Unity Catalog Metadados delta

Ler dados de tabelas

Use a API de leitura de tabelas para recuperar linhas seguras das tabelas OneLake suportadas.

API Protocolo e fluxo de trabalho Formatos de tabelas
API de leitura de tabela (pré-visualização) Aloque fluxos com POST /read, e recupere cada fluxo com GET /readStream/{streamId} Tabelas válidas de Delta Lake e Apache Iceberg

Pré-requisitos

Antes de usar estas APIs, identifique algumas informações e selecione o seu fluxo preferido de autenticação do Microsoft Entra ID.

Recolha informações básicas

Recolha as seguintes informações:

  • O seu ID de inquilino do Fabric.

    O identificador do locatário é um GUID. Encontre-o no Cartão de Perfil ou em Ajuda>Sobre Fabric.

  • O espaço de trabalho e o ID do item de dados (como um lakehouse) com um diretório Tables no nível superior.

    Esses IDs são GUIDs (Identificadores Globais Universais). Podem ser encontrados no URL de qualquer tabela dentro do OneLake. Como alternativa, eles podem ser encontrados dentro da URL vista em seu navegador quando você tem um item de dados aberto no Fabric.

  • O nome do esquema e o nome da tabela que queres aceder. Para a API de leitura de tabelas, a tabela deve ser válida como tabela Delta Lake ou Apache Iceberg.

  • Uma identidade de utilizador ou principal de serviço no Microsoft Entra ID que tenha as permissões necessárias para as operações que planeia utilizar.

    • As operações de leitura requerem permissão para ler as tabelas de destino. A API de leitura de tabelas utiliza as permissões e as políticas de segurança dos dados associadas a esta identidade ao devolver linhas e colunas.
    • As operações de escrita requerem acesso de escrita ao item de dados alvo e à localização OneLake. Dependendo do tipo de item e do modelo de acesso, conceda uma função de item ou de espaço de trabalho que permita escritas, ou conceda ReadWrite através de uma função de acesso a dados OneLake. Para obter mais informações, consulte Introdução à segurança do OneLake.

Preparar-se para autenticação

Faz um plano de como queres autenticar-te com a API.

  1. Decida como você gostaria de se autenticar com o ID do Microsoft Entra para obter um token de acesso para a identidade do Microsoft Entra escolhida.

    Você pode verificar este guia para saber mais sobre as diferentes maneiras de obter um token de acesso com o Microsoft Entra ID. A Microsoft oferece bibliotecas de autenticação convenientes em vários idiomas.

  2. Se você estiver desenvolvendo um novo aplicativo que permitirá que os usuários entrem ou entrem como um aplicativo autônomo, registre seu aplicativo com o Microsoft Entra ID.

  3. Conceda permissão de API para o destinatário de token do Armazenamento do Azure (https://storage.azure.com/) na sua aplicação Microsoft Entra ID. Conceder esta permissão garante que a sua aplicação possa obter tokens para utilização com o endpoint da tabela OneLake.

    Observação

    O ponto de extremidade da API da tabela OneLake aceita o mesmo destinatário de token que os pontos de extremidade do sistema de ficheiros OneLake.

    Se está a desenvolver uma aplicação, talvez já saiba como autenticar com o Microsoft Entra ID para interagir com APIs REST do sistema de ficheiros OneLake. Se sim, pode usar a mesma abordagem para autenticar com o endpoint da tabela OneLake.