Usar a API de conectores do Microsoft Graph

Artigo
12/21/2023

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Você pode usar conectores do Microsoft Graph para trazer dados de serviços externos para o Microsoft Graph. A API de conectores do Microsoft Graph permite indexar dados externos para alimentar experiências inteligentes no Microsoft 365, como Copilot e Microsoft Pesquisa.

As solicitações para indexar dados são executadas em nome de um aplicativo sem a presença de um usuário conectado por meio de um token de acesso com permissão do aplicativo.

Criar um conector personalizado do Microsoft Graph

A criação de um conector personalizado do Microsoft Graph envolve quatro etapas:

Crie um registro de aplicativo entra ID (anteriormente conhecido como Azure Active Directory). Junto com a solicitação ao Microsoft Graph, você envia o nome do registro do aplicativo e as permissões de API que seu aplicativo precisa. O Microsoft Graph responde com informações sobre o registro de aplicativo recém-criado.
Crie uma conexão externa. Cada conexão requer uma ID exclusiva, um nome e uma descrição.
Crie o esquema para a conexão externa. O esquema define a forma de conteúdo externo que você ingerirá por meio dessa conexão do Microsoft Graph. Criar o esquema é uma operação de longa execução. Depois de enviar o esquema para criar a conexão, o Microsoft Graph responde com uma URL que você pode usar para marcar o status da operação. O esquema está sendo provisionado desde que a operação status seja inprogress. Quando o provisionamento for concluído, a operação retornará um completed status.
Ingerir conteúdo externo. Para cada item externo, extraia-o do repositório de conteúdo de origem, transforme-o para que ele corresponda ao esquema de sua conexão externa e envie-o ao Microsoft Graph como um item externo. Junto com o item, inclua informações sobre quem tem permissão para acessá-lo, também conhecida como ACL (lista de controle de acesso).

A seguir está um diagrama de sequência que ilustra as quatro etapas para criar um conector do Microsoft Graph.

Um diagrama que mostra as quatro etapas para criar um conector do Microsoft Graph

Casos de uso comuns

A tabela a seguir lista casos de uso comuns para a API de conectores do Microsoft Graph.

Casos de uso	Recursos REST	Confira também
Ações de configuração
Criar, atualizar ou excluir uma conexão	externalConnection	Métodos de externalConnection
Registrar um esquema para os dados externos	schema	métodos de esquema
Ações de indexação
Adicionar, atualizar ou excluir um item personalizado no índice	externalItem	métodos de externalItem

Limitações conhecidas

A seguir estão as limitações conhecidas atuais:

As organizações estão limitadas a um máximo de 10 conexões. (Se você precisar de mais conexões, conclua o formulário de solicitação.)
Você pode criar até 25 itens de recursos externalItem por segundo.
Um aplicativo é limitado a 25 operações simultâneas em uma conexão.
As conexões têm um limite de capacidade de 5.000.000 itens ou ~350 GB de dados.
O tamanho máximo de uma entidade externalItem é de 4 MB.

Próximas etapas

Confira a visão geral dos conectores do Microsoft Graph.
Faça uma busca detalhada sobre os métodos, propriedades e relações dos recursos externalConnection, schemae externalItem.
Confira a coleção postman do Microsoft Graph.
Confira o conector de pesquisa de exemplo.