Connector v2.0 do SharePoint - Amazon Kendra
Recursos compatíveisPré-requisitosInstruções de conexãoObservações

Connector v2.0 do SharePoint

O SharePoint é um serviço colaborativo de criação de sites que você pode usar para personalizar o conteúdo da Web e criar páginas, sites, bibliotecas de documentos e listas. Você pode usar o Amazon Kendra para indexar sua fonte de dados do SharePoint.

No momento, o Amazon Kendra é compatível com o SharePoint Online e o SharePoint Server (versões 2013, 2016, 2019 e Edição de Assinatura).

nota

Connector V1.0/API SharePointConfiguration do SharePoint encerrado em 2023. Recomendamos migrar ou usar o conector V2.0 /API TemplateConfiguration do SharePoint.

Para solucionar problemas do conector da fonte de dados do Amazon Kendra, consulte Solucionar problemas de origens de dados.

Recursos compatíveis

O conector de fonte de dados do SharePoint e do Amazon Kendra oferece suporte aos seguintes recursos:

  • Mapeamentos de campos

  • Controle de acesso do usuário

  • Filtros de inclusão/exclusão

  • Sincronizações completas e incrementais de conteúdo

  • Nuvem privada virtual (VPC)

Pré-requisitos

Antes que você possa usar o Amazon Kendra para indexar a fonte de dados do SharePoint, faça essas alterações no SharePoint e nas contas do AWS.

Você precisa fornecer credenciais de autenticação, que armazena com segurança em um segredo do AWS Secrets Manager.

nota

É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. Não recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).

No SharePoint Online, verifique se você:

  • Copiou os URLs de instância do SharePoint. O formato do URL do host que você insere é https://yourdomain.com/sites/mysite. O URL deve começar com https.

  • Copiou o nome de domínio da URL da instância do SharePoint.

  • Anotou as credenciais de autenticação básicas, que incluem um nome de usuário e uma senha com no mínimo permissão de administrador para conectar o SharePoint Online.

  • Desativou os padrões de segurança no portal do Azure usando um usuário administrativo. Para obter mais informações sobre como gerenciar as configurações padrão de segurança no portal do Azure, consulte a documentação da Microsoft sobre como habilitar/desabilitar padrões de segurança.

  • Desativou a autenticação multifator (MFA) em sua conta do SharePoint, para que o Amazon Kendra não seja impedido de realizar crawling no conteúdo do SharePoint.

  • Se estiver usando um tipo de autenticação diferente da autenticação básica: copiou a ID do inquilino da instância do SharePoint. Para obter detalhes sobre como encontrar o ID de inquilino, consulte Encontre o ID de inquilino do Microsoft 365.

  • Se você precisar migrar para a autenticação de usuário na nuvem com o Microsoft Entra, consulte a documentação da Microsoft sobre a autenticação na nuvem.

  • Para autenticação OAuth 2.0 e autenticação com token de atualização OAuth 2.0: anote as credenciais de autenticação básica que contêm o nome de usuário e a senha usados para se conectar ao SharePoint Online e o ID e a senha do cliente gerados depois de registrar o SharePoint com o Azure AD.

    • Se não estiver usando a ACL, adicione as seguintes permissões:

      Microsoft Graph SharePoint

      • Notes.Read.All (aplicativo): leia todos os blocos de anotações do OneNote

      • Sites.Read.All (Application): leia itens em todos os conjuntos de sites (Site.Read.All)

      • AllSites.Read (delegado): leia itens em todos os conjuntos de sites
      nota

      Note.Read.All e Sites.Read.All são necessários somente se você quiser rastrear documentos do OneNote.

      Se quiser realizar crawling em sites específicos, a permissão pode ser restrita a eles em vez de a todos os sites disponíveis no domínio. Você configura a permissão Sites.Selected (aplicação). Com essa permissão de API, você precisa definir explicitamente a permissão de acesso em cada site por meio da API do Microsoft Graph. Para obter mais informações, consulte o blog da Microsoft em permissões Sites.Selected.

    • Se não estiver usando a ACL, adicione as seguintes permissões:

      Microsoft Graph SharePoint

      • Group.Member.Read.All (Aplicativo): leia todas as associações do grupo

      • Notes.Read.All (aplicativo): leia todos os blocos de anotações do OneNote

      • Sites.FullControl.All (delegado): necessário para recuperar ACLs dos documentos

      • Sites.Read.All (Application): leia itens em todos os conjuntos de sites (Site.Read.All)

      • User.Read.All (Application): leia o perfil completo de todos os usuários (User.Read.All)

      • AllSites.Read (delegado): leia itens em todos os conjuntos de sites
      nota

      GroupMember.Read.all e User.Read.All são necessários somente se o Identity Crawler estiver ativado.

      Se quiser realizar crawling em sites específicos, a permissão pode ser restrita a eles em vez de a todos os sites disponíveis no domínio. Você configura a permissão Sites.Selected (aplicação). Com essa permissão de API, você precisa definir explicitamente a permissão de acesso em cada site por meio da API do Microsoft Graph. Para obter mais informações, consulte o blog da Microsoft em permissões Sites.Selected.

  • Para autenticação somente da aplicação Azure AD: a chave privada e a ID do cliente gerados após registrar o SharePoint com o Azure AD. Observe também o certificado X.509.

    • Se não estiver usando a ACL, adicione as seguintes permissões:

      SharePoint

      • Sites.Read.All (aplicativo): exigido para acessar itens e listas em todos os conjuntos de sites
      nota

      Se quiser realizar crawling em sites específicos, a permissão pode ser restrita a eles em vez de a todos os sites disponíveis no domínio. Você configura a permissão Sites.Selected (aplicação). Com essa permissão de API, você precisa definir explicitamente a permissão de acesso em cada site por meio da API do Microsoft Graph. Para obter mais informações, consulte o blog da Microsoft em permissões Sites.Selected.

    • Se não estiver usando a ACL, adicionou as seguintes permissões:

      SharePoint

      • Sites.FullControl.All (aplicativo): necessário para recuperar ACLs dos documentos
      nota

      Se quiser realizar crawling em sites específicos, a permissão pode ser restrita a eles em vez de a todos os sites disponíveis no domínio. Você configura a permissão Sites.Selected (aplicação). Com essa permissão de API, você precisa definir explicitamente a permissão de acesso em cada site por meio da API do Microsoft Graph. Para obter mais informações, consulte o blog da Microsoft em permissões Sites.Selected.

  • Para autenticação somente de aplicativos do SharePoint: anote o ID e a senha do cliente do SharePoint gerados ao conceder permissão somente ao SharePoint App. O ID do cliente e a senha do cliente gerados ao registrar o aplicativo do SharePoint com o Azure AD.

    nota

    A autenticação somente de aplicativos do SharePoint não tem suporte para a versão 2013 do SharePoint.

    • (Opcional) Se você estiver rastreando documentos do OneNote e usando o Identity Crawler, adicione as seguintes permissões:

      Microsoft Graph

      • Group.Member.Read.All (aplicativo): leia todas as associações do grupo

      • Notes.Read.All (aplicativo): leia todos os blocos de anotações do OneNote

      • Sites.Read.All (Application): leia itens em todos os conjuntos de sites (Site.Read.All)

      • User.Read.All (Application): leia o perfil completo de todos os usuários (User.Read.All)
    nota

    Nenhuma permissão de API é necessária para rastrear entidades usando a autenticação básica e a autenticação somente para aplicativo do SharePoint.

No SharePoint Server, verifique se você:

  • Copiou os URLs da instância do SharePoint e o nome de domínio dos URLs do SharePoint. O formato do URL do host que você insere é https://yourcompany/sites/mysite. O URL deve começar com https.

    nota

    (On-premises/servidor) O Amazon Kendra verifica se as informações do endpoint no AWS Secrets Manager são as mesmas informações do endpoint especificadas nos detalhes de configuração da fonte de dados. Isso ajuda a proteger contra o problema de assistência confusa, que é um problema de segurança em que um usuário não tem permissão para realizar uma ação, mas usa o Amazon Kendra como proxy para acessar a senha configurada e realizar a ação. Se você alterar posteriormente as informações do endpoint, crie uma nova senha para sincronizar essas informações.

  • Desativou a autenticação multifator (MFA) em sua conta do SharePoint, para que o Amazon Kendra não seja impedido de realizar crawling no conteúdo do SharePoint.

  • Se estiver usando a autenticação apenas para aplicativos do SharePoint para controle de acesso:

    • Copiou o ID do cliente do SharePoint gerado ao registrar o aplicativo somente no nível do site. O formato de ID do cliente é ClientId@TenantId. Por exemplo, ffa956f3-8f89-44e7-b0e4-49670756342c @888d0b57 -69f1-4fb8-957f-e1f0bedf82fe.

    • Copiou a senha do cliente do SharePoint gerado ao registrar a aplicação somente no nível do site.

    Observação: como IDs e senhas de cliente são gerados para sites únicos somente quando você registra a autenticação do SharePoint Server somente para aplicativos, somente um URL de site é suportado para a autenticação SharePoint somente para aplicativos.

    nota

    A autenticação somente de aplicativos do SharePoint não tem suporte para a versão 2013 do SharePoint.

  • Se estiver usando o ID de e-mail com domínio personalizado para controle de acesso:

    • Anote o valor do domínio de e-mail personalizado, por exemplo: "amazon.com".

  • Se estiver usando o ID de e-mail com domínio a partir da autorização do IDP, faça uma cópia:

    • Endpoint do servidor LDAP (endpoint do servidor LDAP, incluindo protocolo e número da porta). Por exemplo: ldap://example.com:389.

    • Base de pesquisa LDAP (base de pesquisa do usuário LDAP). Por exemplo: CN=Users,DC=sharepoint,DC=com.

    • Nome de usuário e senha LDAP.

  • Credenciais de autenticação NTLM configuradas ou credenciais de autenticação Kerberos configuradas contendo um nome de usuário (nome de usuário da conta do SharePoint) e senha (senha da conta do SharePoint).

No Conta da AWS, verifique se você:

  • Criou um índice do Amazon Kendra e, se estiver usando a API, anotou o ID do índice.

  • Criou uma função do IAM para a fonte de dados e, se estiver usando a API, anotou o ARN da função do IAM.

    nota

    Se você alterar o tipo de autenticação e as credenciais, deverá atualizar a função do IAM para acessar o ID secreto correto do AWS Secrets Manager.

  • Armazenou as credenciais de autenticação do SharePoint em uma senha do AWS Secrets Manager e, se estiver usando a API, anotou o ARN da senha.

    nota

    Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. Não recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).

Se você não tiver uma função ou senha existente do IAM, poderá usar o console para criar uma nova função do IAM e um nova senha do Secrets Manager ao conectar a fonte de dados do SharePoint ao Amazon Kendra. Se você estiver usando a API, deverá fornecer o ARN de uma função da IAM e a senha Secrets Manager existentes e um ID de índice.

Instruções de conexão

Para conectar Amazon Kendra à sua fonte de dados do SharePoint, você deve fornecer detalhes das credenciais do SharePoint para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou SharePoint para Amazon Kendra, consulte Pré-requisitos.

Console: SharePoint Online

Para se conectar Amazon Kendra ao SharePoint Online

  1. Faça login no Console de gerenciamento da AWS e abra o console do Amazon Kendra.

  2. No painel de navegação esquerdo, escolha Índices e, em seguida, escolha o índice que deseja usar na lista de índices.

    nota

    Você pode escolher definir ou editar as configurações de Controle de acesso do usuário em Configurações do índice.

  3. Na página Introdução, escolha Adicionar fonte de dados.

  4. Na página Adicionar fonte de dados, escolha o Conector do SharePoint e selecione Adicionar conector. Se estiver usando a versão 2 (se aplicável), escolha o conector SharePoint com a tag “V2.0".

  5. Na página Especar detalhes da fonte de dados, insira as seguintes informações:

    1. Em Nome e descrição, em Nome da fonte de dados: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.

    2. (Opcional) Descrição: insira uma descrição opcional para a fonte de dados.

    3. Em Idioma padrão: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.

    4. Em Tags, em Adicionar nova tag: inclua tags opcionais para pesquisar e filtrar os recursos ou monitorar os custos da AWS.

    5. Escolha Próximo.

  6. Na página Definir seção e segurança, insira as informações a seguir:

    1. Método de hospedagem: selecione SharePoint Online.

    2. URLs de sites específicos do repositório do SharePoint: insira os URLs do site específicos do repositório do SharePoint. O formato do URL do host que você insere é https://yourdomain.sharepoint.com/sites/mysite. O URL deve começar com o protocolo https. Separe os URLs com uma nova linha. Você pode adicionar até 100 URLs.

    3. Domínio: insira o domínio do SharePoint. Por exemplo, o domínio no URL https://yourdomain.sharepoint.com/sites/mysite é yourdomain.

    4. Autorização: ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte Filtrar o contexto do usuário.

      Você também pode escolher o tipo de ID do usuário, seja o nome da entidade principal do usuário ou o e-mail do usuário obtido no portal do Azure. Se você não especificar, o e-mail será usado por padrão.

    5. Autenticação: escolha entre básica, OAuth 2.0, autenticação somente para aplicação do Azure AD, autenticação somente para aplicação do SharePoint e autenticação com token de atualização OAuth 2.0. Escolha um segredo já existente do AWS Secrets Manager para armazenar as credenciais de autenticação ou crie um segredo.

      1. Se estiver usando a Autenticação básica, o segredo deverá incluir um nome de secreto, além de nome de usuário e senha do SharePoint.

      2. Se estiver usando a Autenticação OAuth 2.0, o segredo deverá incluir o ID do locatário do SharePoint, o nome do segredo, o nome de usuário do SharePoint, a senha, o ID do cliente do Azure AD gerado quando você registra o SharePoint no Azure AD e o segredo do cliente do Azure AD gerado ao registrar o SharePoint no Azure AD.

      3. Se estiver usando a Autenticação somente de aplicação do Azure AD, o segredo deverá incluir o ID do locatário do SharePoint, o certificado X.509 autoassinado do Azure AD, o nome do segredo, o ID do cliente do Azure AD gerado quando você registra o SharePoint no Azure AD e a chave privada para autenticar o conector do Azure AD.

      4. Se estiver usando a Autenticação somente de aplicação do SharePoint, o segredo deverá incluir o ID do locatário do SharePoint, o nome do segredo, o ID do cliente do SharePoint que você gerou ao registrar o SharePoint somente no nível do locatário, o ID do cliente do Azure AD gerado ao registrar o SharePoint no Azure AD e o segredo do cliente do Azure AD gerado ao registrar o SharePoint no Azure AD.

        O formato do ID do cliente do SharePoint é ClientID@TenantId. Por exemplo, ffa956f3-8f89-44e7-b0e4-49670756342c @888d0b57 -69f1-4fb8-957f-e1f0bedf82fe.

      5. Se estiver usando a Autenticação com token de atualização OAuth 2.0, o segredo deverá incluir o ID do locatário do SharePoint, o nome do segredo, o ID exclusivo do cliente do Azure AD gerado quando você registra o SharePoint no Azure AD, o segredo do cliente do Azure AD gerado ao registrar o SharePoint no Azure AD e o token de atualização gerado para conectar o Amazon Kendra ao SharePoint.

    6. Nuvem privada virtual (VPC): você pode escolher usar uma VPC. Nesse caso, você deve adicionar sub-redes e grupos de segurança da VPC.

    7. Crawler de identidade: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se tiver uma ACL para seus documentos e usá-la, você também poderá optar por ativar o crawler de identidade do Amazon Kendra para configurar a filtragem no contexto do usuário dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se quiser usar o controle de acesso para seus documentos e o crawler de identidade estiver desativado, você poderá usar como alternativa a API PutPrincipalMapping para fazer upload de informações de acesso de usuários e grupos para filtragem no contexto do usuário.

      Você também pode optar por fazer crawling do mapeamento de grupos locais ou o mapeamento de grupos do Azure Active Directory.

      nota

      O crawling do mapeamento do de grupos do AD está disponível somente para autenticação com OAuth 2.0, token de atualização OAuth 2.0 e autenticação somente para aplicação do SharePoint.

    8. Função do IAM: escolha uma função do IAM existente ou crie uma nova função do IAM para acessar as credenciais do repositório e indexar o conteúdo.

      nota

      Funções do IAM usadas para índices não podem ser usados para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha Criar uma nova função para evitar erros.

    9. Escolha Próximo.

  7. Na página Configurar configurações de sincronização, insira as seguintes informações:

    1. Em Sincronizar escopo, escolha uma das opções a seguir:

      1. Selecionar entidades: escolha as entidades que você deseja rastrear. Você pode optar por rastrear todas as entidades ou qualquer combinação de arquivos, anexos, páginas de links, eventos, comentários e dados da lista.

      2. Em Configuração adicional, para Padrões de regex de entidades: adicione padrões de expressão regular para Links, Páginas e Eventos para incluir entidades específicas em vez de sincronizar todos os documentos.

      3. Padrões Regex: adicione padrões de expressão regular para incluir ou excluir arquivos por caminho do arquivo, nome do arquivo, tipo de arquivo, nome da seção do OneNote e nome da página do OneNote em vez de sincronizar todos os documentos. Você pode adicionar até 100.

        nota

        O crawling do OneNote está disponível somente para OAuth 2.0, token de atualização OAuth 2.0 e autenticação somente para aplicação do SharePoint.

    2. No Modo de sincronização, escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados do Amazon Kendra pela primeira vez, todo o conteúdo é sincronizado por padrão.

      • Sincronização completa: sincronize todo o conteúdo, independentemente do status de sincronização anterior.

      • Sincronização de documentos novos ou modificados: sincronize somente documentos novos e modificados.

      • Sincronização de documentos novos, modificados ou excluídos: sincronize somente documentos novos, modificados e excluídos.

    3. Em Programação de execução de sincronização, em Frequência: escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar o índice.

    4. Escolha Próximo.

  8. Na página Definir mapeamentos de campo, insira as seguintes informações:

    1. Campos de fonte de dados padrão: selecione entre os campos da fonte de dados padrão gerados do Amazon Kendra que você deseja mapear para o índice.

    2. Adicionar campo: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.

    3. Escolha Próximo.

  9. Na página Revisar e criar, verifique se as informações inseridas estão corretas e selecione Adicionar fonte de dados. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página Fontes de dados depois que a fonte de dados for adicionada com sucesso.

Console: SharePoint Server

Para se conectar Amazon Kendra ao SharePoint

  1. Faça login no Console de gerenciamento da AWS e abra o console do Amazon Kendra.

  2. No painel de navegação esquerdo, escolha Índices e, em seguida, escolha o índice que deseja usar na lista de índices.

    nota

    Você pode escolher definir ou editar as configurações de Controle de acesso do usuário em Configurações do índice.

  3. Na página Introdução, escolha Adicionar fonte de dados.

  4. Na página Adicionar fonte de dados, escolha o Conector do SharePoint e selecione Adicionar conector. Se estiver usando a versão 2 (se aplicável), escolha o conector SharePoint com a tag “V2.0".

  5. Na página Especar detalhes da fonte de dados, insira as seguintes informações:

    1. Em Nome e descrição, em Nome da fonte de dados: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.

    2. (Opcional) Descrição: insira uma descrição opcional para a fonte de dados.

    3. Em Idioma padrão: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.

    4. Em Tags, em Adicionar nova tag: inclua tags opcionais para pesquisar e filtrar os recursos ou monitorar os custos da AWS.

    5. Escolha Próximo.

  6. Na página Definir seção e segurança, insira as informações a seguir:

    1. Método de hospedagem: escolha Servidor do SharePoint.

    2. Escolha a versão do SharePoint: escolha entre o SharePoint 2013, o SharePoint 2016, o SharePoint 2019 e o SharePoint (Edição de Assinatura).

    3. URLs de sites específicos do repositório do SharePoint: insira os URLs do site específicos do repositório do SharePoint. O formato do URL do host que você insere é https://yourcompany/sites/mysite. O URL deve começar com o protocolo https. Separe os URLs com uma nova linha. Você pode adicionar até 100 URLs.

    4. Domínio: insira o domínio do SharePoint. Por exemplo, o domínio no URL https://yourcompany/sites/mysite é yourcompany

    5. Localização do certificado SSL: escolha inserir o caminho do Amazon S3 para o arquivo do certificado SSL.

    6. (Opcional) Proxy Web: insira o nome do host (sem o protocolo http:// ou https://) e o número da porta usada pelo protocolo de transporte de URL do host. O número da porta deve ser um valor numérico entre 0 e 65535.

    7. Autorização: ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte Filtrar o contexto do usuário.

      Para o SharePoint Server, você pode escolher entre as seguintes opções de ACL:

      1. ID de e-mail com domínio do IDP: o ID de usuário será baseado em IDs de e-mail com seus domínios obtidos do provedor de identidades (IDP) subjacente. Você fornece os detalhes da conexão do IDP no segredo do Secrets Manager como parte da Autenticação.

      2. ID de e-mail com domínio personalizado: o ID de usuário é baseado no valor do domínio de e-mail personalizado. Por exemplo, "amazon.com". O domínio de e-mail será usado para criar o ID de e-mail para controle de acesso. Você deve inserir seu domínio de e-mail personalizado.

      3. Domínio\Usuário com domínio: o ID de usuário é estruturado usando o formato Domínio\ID de usuário. Você precisa fornecer um nome de domínio válido. Por exemplo: “sharepoint2019" para construir o controle de acesso.

    8. Em Autenticação, escolha entre autenticação somente para aplicação do SharePoint, autenticação NTLM e autenticação Kerberos. Escolha um segredo já existente do AWS Secrets Manager para armazenar as credenciais de autenticação ou crie um segredo.

      1. Se estiver usando a Autenticação NTLM ou a Autenticação Kerberos, o segredo deverá incluir um nome de secreto, além de nome de usuário e senha do SharePoint.

        Se estiver usando o ID de e-mail com o domínio do IDP, insira também:

        • Endpoint do servidor LDAP: endpoint do servidor LDAP, incluindo protocolo e número da porta. Por exemplo: ldap://example.com:389.

        • Base de pesquisa LDAP — Base de pesquisa do usuário LDAP. Por exemplo: CN=Users,DC=sharepoint,DC=com.

        • Nome de usuário do LDAP: o nome de usuário do LDAP.

        • Senha LDAP: a senha LDAP.

      2. Se estiver usando a Autenticação somente de aplicação do SharePoint, o segredo deverá incluir um nome de segredo, o ID do cliente do SharePoint que você gerou ao registrar a aplicação somente no nível do site, o segredo do cliente do SharePoint gerado quando você se registrou somente na aplicação no nível do site.

        O formato do ID do cliente do SharePoint é ClientID@TenantId. Por exemplo, ffa956f3-8f89-44e7-b0e4-49670756342c @888d0b57 -69f1-4fb8-957f-e1f0bedf82fe.

        Observação: como IDs e senhas de cliente são gerados para sites únicos somente quando você registra a autenticação do SharePoint Server somente para aplicativos, somente um URL de site é suportado para a autenticação SharePoint somente para aplicativos.

        Se estiver usando o ID de e-mail com o domínio do IDP, insira também:

        • Endpoint do servidor LDAP: endpoint do servidor LDAP, incluindo protocolo e número da porta. Por exemplo: ldap://example.com:389.

        • Base de pesquisa LDAP — Base de pesquisa do usuário LDAP. Por exemplo: CN=Users,DC=sharepoint,DC=com.

        • Nome de usuário do LDAP: o nome de usuário do LDAP.

        • Senha LDAP: a senha LDAP.

    9. Nuvem privada virtual (VPC): você pode escolher usar uma VPC. Nesse caso, você deve adicionar sub-redes e grupos de segurança da VPC.

    10. Crawler de identidade: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se tiver uma ACL para seus documentos e usá-la, você também poderá optar por ativar o crawler de identidade do Amazon Kendra para configurar a filtragem no contexto do usuário dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se quiser usar o controle de acesso para seus documentos e o crawler de identidade estiver desativado, você poderá usar como alternativa a API PutPrincipalMapping para fazer upload de informações de acesso de usuários e grupos para filtragem no contexto do usuário.

      Você também pode optar por fazer crawling do mapeamento de grupos locais ou o mapeamento de grupos do Azure Active Directory.

      nota

      O crawling do mapeamento de grupos do AD só está disponível para a autenticação somente para aplicação do SharePoint.

    11. Função do IAM: escolha uma função do IAM existente ou crie uma nova função do IAM para acessar as credenciais do repositório e indexar o conteúdo.

      nota

      Funções do IAM usadas para índices não podem ser usados para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha Criar uma nova função para evitar erros.

    12. Escolha Próximo.

  7. Na página Configurar configurações de sincronização, insira as seguintes informações:

    1. Em Sincronizar escopo, escolha uma das opções a seguir:

      1. Selecionar entidades: escolha as entidades que você deseja rastrear. Você pode optar por rastrear todas as entidades ou qualquer combinação de arquivos, anexos, páginas de links, eventos e dados da lista.

      2. Em Configuração adicional, para Padrões de regex de entidades: adicione padrões de expressão regular para Links, Páginas e Eventos para incluir entidades específicas em vez de sincronizar todos os documentos.

      3. Padrões Regex: adicione padrões de expressão regular para incluir ou excluir arquivos por caminho do arquivo, nome do arquivo, tipo de arquivo, nome da seção do OneNote e nome da página do OneNote em vez de sincronizar todos os seus documentos. Você pode adicionar até 100.

        nota

        O crawling do OneNote só está disponível para a autenticação somente para aplicação do SharePoint.

    2. Modo de sincronização: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.

      • Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.

      • Sincronização nova e modificada: indexe somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

      • Sincronização nova, modificada e excluída: indexe somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

    3. Em Programação de execução de sincronização, em Frequência: escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar o índice.

    4. Escolha Próximo.

  8. Na página Definir mapeamentos de campo, insira as seguintes informações:

    1. Campos de fonte de dados padrão: selecione entre os campos da fonte de dados padrão gerados do Amazon Kendra que você deseja mapear para o índice.

    2. Adicionar campo: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.

    3. Escolha Próximo.

  9. Na página Revisar e criar, verifique se as informações inseridas estão corretas e selecione Adicionar fonte de dados. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página Fontes de dados depois que a fonte de dados for adicionada com sucesso.

API

Para se conectar Amazon Kendra ao SharePoint

Especifique um JSON do esquema da fonte de dados usando a API TemplateConfiguration. Você deve fornecer as seguintes informações:

  • Fonte de dados: especifique o tipo de fonte de dados como SHAREPOINTV2 quando você usa o esquema JSON TemplateConfiguration. Também especifique a fonte de dados como TEMPLATE quando você chama a API CreateDataSource.

  • Metadados do endpoint do repositório: especifique o fim da sua instância tenantID, domain e siteUrls do SharePoint.

  • Modo de sincronização: especifique como o Amazon Kendra deve atualizar o índice quando o conteúdo da fonte de dados é alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:

    • FORCED_FULL_CRAWL para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.

    • FULL_CRAWL para indexar somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

    • CHANGE_LOG para indexar somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

  • Crawler de identidade: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se tiver uma ACL para seus documentos e usá-la, você também poderá optar por ativar o crawler de identidade do Amazon Kendra para configurar a filtragem no contexto do usuário dos resultados da pesquisa. Caso contrário, se o crawler de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se quiser usar o controle de acesso para seus documentos e o crawler de identidade estiver desativado, você poderá usar como alternativa a API PutPrincipalMapping para fazer upload de informações de acesso de usuários e grupos para filtragem no contexto do usuário.

    nota

    O crawler de identidade está disponível somente ao definir crawlAcl como true.

  • Propriedades adicionais do repositório, especifique:

    • (Somente para Azure AD) Você usa s3bucketName e s3certificateName para armazenar o certificado X.509 autoassinado do Azure AD.

    • Tipo de autenticação (auth_Type) que você usa, se OAuth2, OAuth2App, OAuth2Certificate, Basic, OAuth2_RefreshToken, NTLM e Kerberos.

    • Versão (version) que você usa, seja Server ou Online. Se você usar Server, poderá especificar ainda mais onPremVersion como 2013, 2016, 2019 ou SubscriptionEdition.

  • Nome do recurso da Amazon (ARN) de senha: forneça o nome do recurso da Amazon (ARN) de uma senha do Secrets Manager que contenha as credenciais de autenticação criadas na conta do .

    Se você usa o SharePoint Online, pode escolher entre a autenticação Básica, OAuth 2.0, Azure AD somente para aplicativo e SharePoint somente para aplicativo. Veja a seguir a estrutura JSON mínima que deve estar presente em sua senhao para cada opção de autenticação:

    • Autenticação básica

      {
    "userName": "SharePoint account user name",
    "password": "SharePoint account password"
}

    • Autenticação OAuth

      {
    "clientId": "client id generated when registering SharePoint with Azure AD",
    "clientSecret": "client secret generated when registering SharePoint with Azure AD",
    "userName": "SharePoint account user name",
    "password": "SharePoint account password"
}

    • Autenticação somente para aplicativo do Azure AD

      {
    "clientId": "client id generated when registering SharePoint with Azure AD",
    "privateKey": "private key to authorize connection with Azure AD"
}

    • Autenticação somente para aplicativo do SharePoint

      {
    "clientId": "client id generated when registering SharePoint for App Only at Tenant Level",
    "clientSecret": "client secret generated when registering SharePoint for App Only at Tenant Level",
    "adClientId": "client id generated while registering SharePoint with Azure AD",
    "adClientSecret": "client secret generated while registering SharePoint with Azure AD"
}

    • Autenticação com token de atualização OAuth 

      {
    "clientId": "client id generated when registering SharePoint with Azure AD",
    "clientSecret": "client secret generated when registering SharePoint with Azure AD",
    "refreshToken": "refresh token generated to connect to SharePoint"
}

    Se você usa o SharePoint Server, pode escolher entre a autenticação SharePoint somente para aplicativo, a autenticação NTLM e a autenticação Kerberos. Veja a seguir a estrutura JSON mínima que deve estar presente em sua senhao para cada opção de autenticação:

    • Autenticação somente para aplicativo do SharePoint 

      {
    "siteUrlsHash": "Hash representation of SharePoint site URLs",
    "clientId": "client id generated when registering SharePoint for App Only at Site Level",
    "clientSecret": "client secret generated when registering SharePoint for App Only at Site Level" 
}

    • Autenticação somente para aplicativo do SharePoint com domínio a partir da autorização do IDP

      {
    "siteUrlsHash": "Hash representation of SharePoint site URLs",
    "clientId": "client id generated when registering SharePoint for App Only at Site Level",
    "clientSecret": "client secret generated when registering SharePoint for App Only at Site Level",
    "ldapUrl": "LDAP Account url eg. ldap://example.com:389",
    "baseDn": "LDAP Account base dn eg. CN=Users,DC=sharepoint,DC=com",
    "ldapUser": "LDAP account user name",
    "ldapPassword": "LDAP account password"
}

    • (Somente servidor) Autenticação NTLM ou Kerberos 

      {
    "siteUrlsHash": "Hash representation of SharePoint site URLs",
    "userName": "SharePoint account user name",
    "password": "SharePoint account password"
}

    • (Somente servidor) Autenticação NTLM ou Kerberos com domínio a partir da autorização do IDP

      {
    "siteUrlsHash": "Hash representation of SharePoint site URLs",
    "userName": "SharePoint account user name",
    "password": "SharePoint account password",
    "ldapUrl": "ldap://example.com:389",
    "baseDn": "CN=Users,DC=sharepoint,DC=com",
    "ldapUser": "LDAP account user name",
    "ldapPassword": "LDAP account password"
}

  • Função do IAM: especifique o RoleArn ao chamar o CreateDataSource para fornecer uma função do IAM com permissões para acessar a senha do Secrets Manager e chamar as APIs públicas necessárias para o conector do SharePoint e o Amazon Kendra. Para obter mais informações, consulte Funções do IAM para as fontes de dados do SharePoint.

Você também pode adicionar os seguintes recursos opcionais:

  • Nuvem privada virtual (VPC): especifique a VpcConfiguration quando ao chamar CreateDataSource. Para obter mais informações, consulte Configurar a Amazon Kendra para usar o Amazon VPC.

  • Filtros de inclusão e exclusão: é possível especificar se deseja incluir ou excluir determinados arquivos, conteúdo do OneNote, além de outros conteúdos.

    nota

    A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.

  • Mapeamentos de campo: escolha mapear os campos de fonte de dados do SharePoint para os campos de índice do Amazon Kendra. Para obter mais informações, consulte Mapeamento de campos de fonte de dados.

    nota

    É obrigatório definir o campo de corpo do documento ou equivalente para que o Amazon Kendra possa pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice _document_body. Todos os demais campos são opcionais.

Consulte uma lista de outras chaves JSON importantes a configurar em Esquema do modelo do SharePoint.

Observações

  • O conector oferece suporte a mapeamentos de campo personalizados somente para a entidade Arquivos.

  • Para todas as versões do SharePoint Server, o token ACL deve estar em letras minúsculas. Para eE-mail com domínio do IDP e ID de e-mail com ACL de domínio personalizado como, por exemplo: user@sharepoint2019.com. Para Domínio\Usuário com ACL de domínio como , por exemplo: sharepoint2013\user.

  • Quando as listas de controle de acesso (ACLs) estão ativadas, a opção “Sincronizar somente conteúdo novo ou modificado” não está disponível devido às limitações de API do SharePoint. Em vez disso, recomendamos usar os modos “Sincronização completa” ou “Sincronização de conteúdo novo, modificado ou excluído” ou desativar as ACLs se precisar usar esse modo de sincronização.

  • O conector não oferece suporte ao modo de log de Alterações/sincronização de conteúdo novo ou modificado para o SharePoint 2013.

  • Se o nome de uma entidade tiver um caractere % em seu nome, o conector ignorará esses arquivos devido às limitações da API.

  • O OneNote só pode ser rastreado pelo conector usando um ID de locatário e com a autenticação do OAuth 2.0, do token de atualização OAuth 2.0 ou SharePoint App Only ativada para o SharePoint Online.

  • O conector realiza crawling na primeira seção de um documento do OneNote usando somente o nome padrão, mesmo se o documento for renomeado.

  • O conector rastreia links no SharePoint 2019, no SharePoint Online e na Subscription Edition, somente se asPáginas e os Arquivos forem selecionados como entidades a serem rastreadas, além dos Links.

  • O conector rastreia links no SharePoint 2013 e no SharePoint 2016 se os Links forem selecionados como uma entidade a ser rastreada.

  • O conector rastreia os anexos e os comentários da lista somente quando os Dados da Lista também são selecionados como uma entidade a ser rastreada.

  • O conector rastreia os anexos de eventos somente quando os Eventos também são selecionados como uma entidade a ser rastreada.

  • Para a versão SharePoint Online, o token de ACL está em letras minúsculas. Por exemplo, se o nome da entidade principal do usuário for MaryMajor@domain.com no Portal do Azure, o token da ACL no SharePoint Connector será marymajor@domain.com.

  • No Identity Crawler para SharePoint Online e Server, se você quiser rastrear grupos aninhados, precisará ativar o crawling local e o crawling de grupos do AD.

  • Se você estiver usando o SharePoint Online e o nome da entidade principal do usuário no Portal do Azure for uma combinação de letras maiúsculas e minúsculas, a API do SharePoint o converterá internamente em minúsculas. Por esse motivo, o conector do Amazon Kendra SharePoint define a ACL em minúsculas.