View a markdown version of this page

SharePoint conector V2.0 - Amazon Kendra
Recursos compatíveisPré-requisitosInstruções de conexãoObservações

Amazon Kendra não está mais aberto a novos clientes. Para obter recursos semelhantes a Amazon Kendra, explore as bases de conhecimento da Amazon Bedrock. Saiba mais.

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

SharePoint conector V2.0

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 Amazon Kendra para indexar sua fonte SharePoint de dados.

Amazon Kendra atualmente suporta SharePoint Online e SharePoint Server (2013 e Subscription Edition).

nota

SharePoint V1.0 SharePointConfiguration conector/API terminou em 2023. Recomendamos migrar para ou usar o SharePoint V2.0 TemplateConfiguration conector/API.

Para solucionar problemas do conector da fonte de Amazon Kendra SharePoint dados, consulteSolucionar problemas de origens de dados.

Recursos compatíveis

Amazon Kendra SharePoint o conector de fonte de dados oferece suporte aos seguintes recursos:

  • Mapeamentos de campos

  • Controle de acesso do usuário

  • Inclusion/exclusion filtros

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

  • Nuvem privada virtual (VPC)

Pré-requisitos

Antes que você possa usar Amazon Kendra para indexar sua fonte de SharePoint dados, faça essas alterações em suas SharePoint AWS contas.

Você deve fornecer credenciais de autenticação, que você armazena com segurança em segredo. 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ê tem:

  • Copiou os URLs da sua SharePoint instância. 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 do URL da sua SharePoint instância.

  • Anotou suas credenciais básicas de autenticação contendo o nome de usuário e a senha com permissões de administrador do site para se conectar ao SharePoint Online.

  • Desativar 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 definir padrões enable/disable de segurança.

  • Desativou a autenticação multifator (MFA) em sua SharePoint conta, para que ela não Amazon Kendra seja impedida de rastrear seu conteúdo. SharePoint

  • Se estiver usando um tipo de autenticação diferente da autenticação básica: copiou o ID do locatário da sua SharePoint instância. 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 por token de atualização do OAuth 2.0: anote suas credenciais de autenticação básica contendo o nome de usuário e a senha que você usa para se conectar ao SharePoint Online e o ID do cliente e o segredo do cliente gerados após o registro no Azure AD. SharePoint

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

      Microsoft Graph SharePoint

      • Notes.Read.All (Aplicativo) — Leia todos os OneNote cadernos

      • Sites.Read.All (Aplicativo) — Leia itens em todos os conjuntos de sites

      • 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 OneNote documentos.

      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 (Aplicativo). 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 sobre Sites.Selected permissões.

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

      Microsoft Graph SharePoint

      • Group.Member.Read.All(Aplicação) — Leia todas as associações ao grupo

      • Notes.Read.All (Aplicativo) — Leia todos os OneNote cadernos

      • Sites.FullControl.All(Delegado) — Obrigatório para recuperar ACLs dos documentos

      • Sites.Read.All (Aplicativo) — Leia itens em todos os conjuntos de sites

      • User.Read.All (Aplicativo) — Leia os perfis completos de todos os usuários

      • 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 (Aplicativo). 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 sobre Sites.Selected permissões.

  • Para App-Only autenticação do Azure AD: chave privada e ID do cliente que você gerou após o registro SharePoint no Azure AD. Observe também o X.509 certificado.

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

      SharePoint

      • Sites.Read.All (Aplicativo) — Necessário 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 (Aplicativo). 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 sobre Sites.Selected permissões.

    • 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 (Aplicativo). 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 sobre Sites.Selected permissões.

  • Para SharePoint App-Only autenticação: anotou sua SharePoint ID de cliente e segredo de cliente gerados ao conceder permissão somente para o SharePoint aplicativo, e sua ID de cliente e segredo de cliente gerados quando você registrou seu SharePoint aplicativo no Azure AD.

    nota

    SharePoint App-Only A autenticação não é suportada na versão SharePoint 2013.

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

      Microsoft Graph

      • GroupMember.Read.All(Aplicação) — Leia todas as associações ao grupo

      • Notes.Read.All (Aplicativo) — Leia todos os OneNote cadernos

      • Sites.Read.All (Aplicativo) — Leia itens em todos os conjuntos de sites

      • User.Read.All (Aplicativo) — Leia os perfis completos de todos os usuários
    nota

    Nenhuma permissão de API é necessária para rastrear entidades usando autenticação e SharePoint App-only autenticação básicas.

No SharePoint Servidor, verifique se você tem:

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

    nota

    (On-premise/server) Amazon Kendra verifica se as informações do endpoint incluídas em AWS Secrets Manager são as mesmas especificadas nos detalhes de configuração da sua 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 SharePoint conta, para que ela não Amazon Kendra seja impedida de rastrear seu conteúdo. SharePoint

  • Se estiver usando SharePoint App-Only autenticação para controle de acesso:

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

    • Copiou o segredo SharePoint do cliente gerado quando você registrou o aplicativo somente no nível do site.

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

    nota

    SharePoint App-Only A autenticação não é suportada na versão SharePoint 2013.

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

    • Anotou o valor do seu 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 SharePoint conta) e senha (senha da conta). SharePoint

No seu Conta da AWS, verifique se você tem:

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

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

    nota

    Se você alterar seu tipo de autenticação e suas credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.

  • Armazenou suas credenciais de SharePoint autenticação em um AWS Secrets Manager segredo e, se estiver usando a API, anotou o ARN do segredo.

    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).

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

Instruções de conexão

Para se conectar Amazon Kendra à sua fonte de SharePoint dados, você deve fornecer detalhes de suas SharePoint credenciais para que você Amazon Kendra possa acessar seus dados. Se você ainda não configurou SharePoint para Amazon Kendra verPré-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 Amazon Kendra console.

  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 SharePoint conector 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, para Adicionar nova tag — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.

    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 SharePoint online.

    2. URLs de sites específicos para seu SharePoint repositório — insira os URLs do SharePoint host. O formato dos URLs 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 SharePoint domínio. 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 extraído do portal do Azure. Se você não especificar, o e-mail será usado por padrão.

    5. Autenticação — escolha autenticação básica, OAuth 2.0, Azure AD, autenticação ou App-Only autenticação por token SharePoint App-Only de atualização do 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, seu segredo deve incluir um nome secreto, nome de SharePoint usuário e senha.

      2. Se estiver usando a autenticação OAuth 2.0, seu segredo deverá incluir a ID do SharePoint locatário, o nome do segredo, o nome de SharePoint usuário, a senha, a ID do cliente do Azure AD gerada quando você se registra SharePoint no Azure AD e a chave secreta do cliente do Azure AD gerada quando você se registra SharePoint no Azure AD.

      3. Se estiver usando a App-Only autenticação do Azure AD, seu segredo deverá incluir a ID do SharePoint locatário, o X.509 certificado autoassinado do Azure AD, o nome secreto, a ID do cliente do Azure AD gerada quando você se registra SharePoint no Azure AD e a chave privada para autenticar o conector para o Azure AD.

      4. Se estiver usando SharePoint App-Only autenticação, seu segredo deve incluir o ID do SharePoint locatário, o nome secreto, o ID SharePoint do cliente que você gerou ao registrar o aplicativo somente no nível do locatário, o segredo SharePoint do cliente gerado ao se registrar no aplicativo Somente no nível do locatário, o ID do cliente do Azure AD gerado quando você se registra SharePoint no Azure AD e o segredo do cliente do Azure AD gerado SharePoint ao se registrar no Azure AD.

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

      5. Se estiver usando a autenticação do token de atualização do OAuth 2.0, seu segredo deverá incluir o ID do SharePoint inquilino, o nome do segredo, a ID exclusiva do cliente do Azure AD gerada quando você se registra SharePoint no Azure AD, o segredo do cliente do Azure AD gerado quando você se SharePoint registra no Azure AD e o token de atualização gerado para se conectar. Amazon Kendra 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 você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a filtragem de contexto Amazon Kendra 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 você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a PutPrincipalMapping API para carregar informações de acesso de usuários e grupos para filtragem de contexto de 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 rastreamento de mapeamento de grupos do AD está disponível somente para OAuth 2.0, token de atualização OAuth 2.0 e autenticação somente para aplicativos. SharePoint

    8. IAM função — Escolha uma IAM função existente ou crie uma nova IAM função para acessar suas credenciais do repositório e o conteúdo do índice.

      nota

      IAM as funções usadas para índices não podem ser usadas 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 OneNote seção e nome da OneNote página, em vez de sincronizar todos os seus documentos. Você pode adicionar até 100.

        nota

        OneNote o rastreamento está disponível somente para OAuth 2.0, token de atualização OAuth 2.0 e autenticação somente para aplicativos. 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 de fonte de dados padrão Amazon Kendra gerados que você deseja mapear para seu í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 a SharePoint

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

  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 SharePoint conector 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, para Adicionar nova tag — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.

    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 o SharePoint servidor.

    2. Escolha a SharePoint versão — Escolha SharePoint 2013 ou SharePoint (Edição de assinatura).

    3. URLs de sites específicos para seu SharePoint repositório — insira os URLs do SharePoint host. O formato dos URLs 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 SharePoint domínio. Por exemplo, o domínio no URL https://yourcompany/sites/mysite é yourcompany

    5. Local do certificado SSL — Insira o Amazon S3 caminho 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 SharePoint Servidor, 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 extraídos 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: "sharepointuser" para construir o controle de acesso.

    8. Para Autenticação, escolha SharePoint App-Only autenticação, autenticação NTLM ou 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 autenticação NTLM ou autenticação Kerberos, seu segredo deve incluir um nome secreto, nome de SharePoint usuário e senha.

        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 SharePoint App-Only autenticação, seu segredo deve incluir um nome secreto, ID SharePoint do cliente que você gerou ao registrar o aplicativo somente no nível do site e o segredo SharePoint do cliente gerado ao se registrar no aplicativo Somente no nível do site.

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

        Observação: como os IDs e segredos do cliente são gerados para sites únicos somente quando você registra a autenticação SharePoint Server for App Only, somente um URL de site é suportado para autenticação somente para SharePoint 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 você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a filtragem de contexto Amazon Kendra 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 você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a PutPrincipalMapping API para carregar informações de acesso de usuários e grupos para filtragem de contexto de 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 rastreamento de mapeamento de grupos do AD está disponível somente na autenticação de SharePoint aplicativos.

    11. IAM função — Escolha uma IAM função existente ou crie uma nova IAM função para acessar suas credenciais do repositório e o conteúdo do índice.

      nota

      IAM as funções usadas para índices não podem ser usadas 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 pelo caminho do arquivo Nome do arquivo Tipo de arquivo, nome da OneNote seção e nome da OneNote página em vez de sincronizar todos os seus documentos. Você pode adicionar até 100.

        nota

        OneNote o rastreamento está disponível somente para autenticação somente para SharePoint aplicativos.

    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 conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações de conteúdo e indexar 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 de fonte de dados padrão Amazon Kendra gerados que você deseja mapear para seu í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 a SharePoint

Você deve especificar 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 ao usar 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 final da tenantID domain sua instância. siteUrls SharePoint

  • Modo de sincronização — Amazon Kendra especifique como atualizar seu índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos dados se a sincronização 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_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações de conteúdo e indexar conteúdo que foi alterado desde a última sincronização.

    • CHANGE_LOGpara indexar somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações de conteúdo e indexar 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 você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a filtragem de contexto Amazon Kendra 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 você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a PutPrincipalMapping API para carregar informações de acesso de usuários e grupos para filtragem de contexto de usuário.

    nota

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

  • Propriedades adicionais do repositório, especifique:

    • (Para Azure AD) s3bucketName e s3certificateName você usa para armazenar seu X.509 certificado 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á especificá-los ainda mais onPremVersion como 2013 ouSubscriptionEdition.

  • Nome secreto de recurso da Amazon (ARN) — forneça o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contém as credenciais de autenticação que você criou em sua conta. SharePoint

    Se você usa o SharePoint Online, pode escolher entre autenticação Básica, OAuth 2.0, Azure AD App-only e Somente SharePoint 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 2.0:

      {
    "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"
}

    • App-OnlyAutenticação do Azure AD 

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

    • SharePoint App-Onlyautenticação 

      {
    "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 SharePoint App-Only autenticação, autenticação NTLM e 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:

    • SharePoint App-Onlyautenticação 

      {
    "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" 
}

    • SharePoint App-Onlyautenticação 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"
}

  • IAM função — especifique RoleArn quando você liga CreateDataSource para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar as APIs públicas necessárias para o SharePoint conector e. Amazon Kendra Para obter mais informações, consulte Funções para o IAM das 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 Configurando Amazon Kendra para usar um Amazon VPC.

  • Filtros de inclusão e exclusão — Você pode especificar se deseja incluir ou excluir determinados arquivos e outros conteúdos. OneNotes

    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 Mapear campos de fonte de dados.

    nota

    O campo do corpo do documento ou o equivalente do corpo do documento para seus documentos é obrigatório Amazon Kendra para 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.

Para ver uma lista de outras chaves JSON importantes a serem configuradas, consulte o 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 SharePoint do servidor, o token ACL deve estar em letras minúsculas. Para e-mail com domínio do IDP e ID de e-mail com ACL de domínio personalizado, por exemplo:. user@sharepointuser.com Para Domínio\ Usuário com ACL de Domínio, 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 SharePoint da API. 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 suporta o modo de registro de alterações/sincronização de conteúdo novo ou modificado para 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.

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

  • O conector rastreia a primeira seção de um OneNote documento usando somente seu nome padrão, mesmo que o documento seja renomeado.

  • O conector rastreia links na Edição SharePoint Online e de Assinatura somente se as páginas e os arquivos forem selecionados como entidades a serem rastreadas, além dos links.

  • O conector rastreia links em SharePoint 2013 se Links for selecionado 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 ACL estará em letras minúsculas. Por exemplo, se o nome principal do usuário estiver MaryMajor@domain.com no portal do Azure, o token ACL no SharePoint Conector serámarymajor@domain.com.

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

  • Se você estiver usando o SharePoint Online e o Nome Principal do Usuário no Portal do Azure for uma combinação de maiúsculas e minúsculas, a SharePoint API o converte internamente em minúsculas. Por causa disso, o Amazon Kendra SharePoint conector define a ACL em minúsculas.