Nota
O acesso a esta página requer autorização. Podes tentar iniciar sessão ou mudar de diretório.
O acesso a esta página requer autorização. Podes tentar mudar de diretório.
As APIs REST do Microsoft Fabric foram projetadas para ajudar os desenvolvedores a automatizar o Fabric. As páginas de referência da API REST do Fabric (documentação) são estruturadas para ajudar os desenvolvedores a encontrar as informações de que precisam.
As páginas de referência estão divididas em duas secções principais:
APIs principais - As APIs principais fornecem informações e funcionalidades para todos os itens do Microsoft Fabric. As APIs principais não são específicas de uma carga de trabalho e podem ser usadas em todas as cargas de trabalho. As APIs principais são as APIs CRUD (Create, Read, Update and Delete). Você pode usá-los para criar ou atualizar itens do Fabric juntamente com suas propriedades comuns. As APIs principais podem ser usadas durante a execução de operações em lote que não forçam a manipulação de nenhuma propriedade específica de um determinado tipo de item.
APIs de carga de trabalho - As APIs de carga de trabalho destinam-se a um tipo de item específico na malha.
As seções da página de referência principal e de carga de trabalho listam todas as APIs em ordem alfabética. Cada seção contém uma visão geral que inclui uma lista de todas as APIs na seção e uma lista alfabética das APIs na seção.
Entrada Específica do Item
A seção específica do item detalha as especificidades de cada tipo de item no Fabric. Cada entrada de tipo de item contém:
Visão geral: uma breve descrição do tipo de item.
Pontos de extremidade: lista os pontos de extremidade disponíveis para o tipo de item, juntamente com detalhes sobre parâmetros, formatos de solicitação e resposta e exemplos.
Modelos: Define o modelo de dados para o tipo de item, especificando propriedades e tipos.
Ações: lista as ações disponíveis para o tipo de item, incluindo detalhes sobre parâmetros, formatos de solicitação e resposta e exemplos.
Use a entrada específica do item para entender os aspetos exclusivos da API relacionados a um tipo de item específico e para obter orientação sobre como executar operações relacionadas a esse tipo de item.
Estrutura da página de referência
Cada página de referência tem as seguintes secções:
Visão geral - Um pequeno parágrafo na parte superior do artigo que descreve a API.
Permissões - Uma lista de permissões de usuário necessárias para chamar a API.
Escopo necessário - Uma lista de permissões (também conhecidas como escopos) que a API exige.
Limitações - (Opcional) Uma lista de limitações para a API.
Interface - Exibe o formulário HTTP da API.
Parâmetros de URI - Uma lista de parâmetros usados para identificar um recurso ou recursos específicos.
Corpo da solicitação - Uma lista de propriedades que podem ser passadas para a API.
Respostas - Uma lista de possíveis respostas da API.
Exemplos - Uma lista de exemplos que mostram como usar a API.
Definições - Parâmetros que definem a estrutura e as propriedades de um objeto que pode ser passado para a API.
A nova estrutura de referência da documentação da API destina-se a fornecer uma maneira clara e consistente de acessar e usar as informações da API. Ao separar a seção CORE e a entrada específica do item, esperamos tornar mais fácil para os desenvolvedores encontrar e usar as informações de que precisam para se integrar ao serviço Microsoft Fabric.
Agradecemos seus comentários e sugestões sobre como melhorar a documentação e a API.