SharePoint

O conector do SharePoint oferece acesso SQL aos serviços e servidores do SharePoint.

Versões compatíveis

Esse conector é compatível com o Windows SharePoint Services 3.0, o Microsoft Office SharePoint Server 2007 e versões mais recentes e o SharePoint Online.

Antes de começar

Antes de usar o conector do SharePoint, faça o seguinte:

  • No seu projeto do Google Cloud, faça o seguinte:
    • Verifique se a conectividade de rede está configurada. Para informações sobre padrões de rede, consulte Conectividade de rede.
    • Conceda a função IAM roles/connectors.admin ao usuário que está configurando o conector.
    • Conceda os seguintes papéis de IAM à conta de serviço que você quer usar para o conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Uma conta de serviço é um tipo especial de Conta do Google destinada a representar um usuário não humano que precisa ser autenticado e autorizado a acessar dados nas APIs do Google. Se você não tiver uma conta de serviço, será necessário criar uma. Para mais informações, consulte Como criar uma conta de serviço.

    • Ative os seguintes serviços:
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Para entender como ativar os serviços, consulte Como ativar serviços.

    Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los ao configurar o conector.

Configurar o conector

Para configurar o conector, crie uma conexão com a fonte de dados (sistema de back-end). Uma conexão é específica a uma fonte de dados. Isso significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada para cada uma. Para criar uma conexão, siga estas etapas:

  1. No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.

    Acessar a página "Conexões"

  2. Clique em + Criar novo para abrir a página Criar conexão.
  3. Na seção Local, escolha o local da conexão.
    1. Região: selecione um local na lista suspensa.

      Veja abaixo as regiões compatíveis com o conector:

      Para conferir a lista de todas as regiões com suporte, consulte Locais.

    2. Clique em Próxima.
  4. Na seção Detalhes da conexão, faça o seguinte:
    1. Conector: selecione SharePoint na lista suspensa de conectores disponíveis.
    2. Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
    3. No campo Nome da conexão, insira um nome para a instância de conexão

      Os nomes de conexão precisam atender aos seguintes critérios:

      • Os nomes de conexões podem usar letras, números ou hifens.
      • As letras precisam ser minúsculas.
      • Os nomes das conexões precisam começar com uma letra e terminar com uma letra ou um número.
      • Os nomes das conexões não podem ter mais de 49 caracteres.
    4. Como opção, insira uma Descrição para a instância de conexão.
    5. Como opção, ative o Cloud Logging e selecione um nível de registro. Por padrão, o nível de registro é definido como Error.
    6. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
    7. Opcionalmente, defina as Configurações do nó de conexão:

      • Número mínimo de nós: digite o número mínimo de nós de conexão.
      • Número máximo de nós: digite o número máximo de nós de conexão.

      Um nó é uma unidade (ou réplica) de uma conexão que processa transações. Mais nós são necessários para processar mais transações para uma conexão e, por outro lado, menos nós são necessários para processar menos transações. Para entender como os nós afetam os preços do conector, consulte Preços dos nós de conexão. Se você não inserir qualquer valor, por padrão, os nós mínimos serão definidos como 2 (para melhor disponibilidade) e os nós máximos serão definidos como 50.

    8. Outra opção é clicar em + Adicionar rótulo para adicionar um rótulo à conexão na forma de um par de chave-valor.
    9. Clique em Próxima.
  5. Na seção Destinos, insira os detalhes do host remoto (sistema de back-end) ao qual você quer se conectar.
    1. Tipo de destino: selecione um Tipo de destino. Por exemplo, o endereço do host é https://xxxxx.sharepoint.com.
      • Selecione Endereço do host na lista para especificar o nome do host ou o endereço IP do destino.
      • Para estabelecer uma conexão particular com seus sistemas de back-end, Selecione Anexo de endpoint na lista e depois selecione o anexo de endpoint necessário. na lista Endpoint Attachment.

      Para estabelecer uma conexão pública com os sistemas de back-end com mais segurança, considere configurar endereços IP de saída estáticos para suas conexões e configure as regras de firewall para autorizar apenas os endereços IP estáticos específicos.

      Para inserir outros destinos, clique em +Adicionar destino.

    2. Clique em Próxima.
  6. Na seção Autenticação, insira os detalhes da autenticação.
    1. Selecione um Tipo de autenticação e insira os detalhes relevantes.

      A conexão do SharePoint oferece suporte aos seguintes tipos de autenticação:

      • Credenciais do Windows. Selecione essa opção se você usa a edição local do SharePoint.
      • AzureAD. Selecione esta opção se você usa a edição on-line do SharePoint.
      • Credenciais do cliente OAuth 2.0 com o portador do JWT. Selecione essa opção se você usa credenciais de cliente do OAuth 2.0 com o portador JWT para autenticação.
      • Credenciais do cliente OAuth 2.0 com chave secreta do cliente. Selecione essa opção se você usa credenciais de cliente do OAuth 2.0 com a chave secreta do cliente para autenticação.

      2. Para entender como configurar esses tipos de autenticação, consulte Configurar autenticação.

    2. Clique em Next.
  7. Revisão: revise os detalhes de conexão e autenticação.
  8. Clique em Criar.

Configurar a autenticação

O conector do SharePoint é compatível com os seguintes tipos de autenticação:

Tipo de autenticação de credenciais do Windows

Para ativar o tipo de autenticação de credenciais do Windows, siga estas etapas:
  1. Configure o PSC e crie um anexo de endpoint.
  2. Especifique as credenciais em Google Cloud.

Configurar o PSC e criar um anexo de endpoint

  1. Crie um grupo de instâncias com o IP em que o SharePoint está hospedado.
  2. Crie um balanceador de carga de rede de passagem interna e use o grupo de instâncias criado como back-end. O balanceador de carga interno TCP precisa ter o acesso global ativado.
  3. Publique o balanceador de carga no Private Service Connect. Um anexo de serviço é gerado depois que o balanceador de carga é publicado.
  4. Publicar o serviço e especificar o balanceador de carga criado.
  5. Use o anexo de serviço para criar um anexo de endpoint.
  6. Depois de criar o anexo de endpoint, crie uma conexão do SharePoint com o IP do anexo de endpoint.

    7. Para mais informações sobre como criar um anexo de endpoint, consulte Criar um anexo de endpoint.

Especifique os detalhes das credenciais do Windows em Google Cloud

Ao criar a conexão nos Conectores de integração , especifique os seguintes detalhes:

Na seção Autenticação, selecione Credenciais do Windows como o tipo de autenticação e insira os seguintes detalhes:

  • Nome de usuário: digite o nome de usuário.
  • Senha: selecione a senha.
  • Versão do secret: insira a versão do secret.

Tipo de conexão de credenciais do Windows

A tabela a seguir lista os valores de configuração de exemplo para o tipo de conexão de credenciais do Windows.
Nome do campo Detalhes
Região us-central1
Conector SharePoint
Versão do conector 1
Nome da conexão sharepoint-staging-psc
Conta de serviço SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Número mínimo de nós 2
Número máximo de nós 50
Tipo de destino Endereço do host
host 1 http://192.0.2.0
porta 1 24
Autenticação Credenciais do Windows
Nome de usuário USER_NAME
Senha SENHA
Versão do secret 1

Tipo de autenticação do Azure AD

Para ativar o tipo de autenticação do Azure AD, siga estas etapas:
  1. Registre o app e receba o OAuthClientId e o OAuthClientSecret.
  2. Especifique as credenciais em Google Cloud.
  3. Autorize a conexão em Google Cloud.
  4. Adicione o URL de redirecionamento ao app.

Registrar o app e receber o OAuthClientId e o OAuthClientSecret

Para registrar o app e receber o OAuthClientId e o OAuthClientSecret, faça o seguinte:
  1. Faça login no Portal do Azure.
  2. Em Azure Services, selecione App Registrations e New registration.
  3. Insira um nome de aplicativo e selecione Qualquer locatário do Microsoft Entra ID: multilocatário. A imagem a seguir mostra a página Registrar um aplicativo:
  4. Depois de criar o app, navegue até a seção Certificados e chaves secretas, crie uma chave secreta para o aplicativo e salve o valor. A imagem a seguir mostra a página Certificates & Secrets:
  5. Em Permissões da API, selecione as permissões do aplicativo e as permissões delegadas necessárias. Para a conexão ficar ativa, você precisa conceder a seguinte permissão mínima:AllSites.Manage

    A tabela a seguir lista as permissões necessárias para realizar operações no aplicativo.

    Permissões delegadas Permissões do app
    ConsentRequest.Read.All AllSites.FullControl
    ConsentRequest.ReadWrite.All AllSites.Manage
    DelegatedAdminRelationship.Read.All AllSites.Read
    DelegatedAdminRelationship.ReadWrite.All AllSites.Write
    DelegatedPermissionGrant.Read.All EnterpriseResource.Read
    DelegatedPermissionGrant.ReadWrite.All EnterpriseResource.Write
    Files.Read.All MyFiles.Read
    Files.ReadWrite.All MyFiles.Write
    Group.Create Project.Read
    Group.Read.All Project.Write
    Group.ReadWrite.All ProjectWebApp.FullControl
    Sites.FullControl.All ProjectWebAppReporting.Read
    Sites.FullControl.All Sites.FullControl.All
    Sites.Manage.All Sites.Manage.All
    Sites.Read.All Sites.Read.All
    Sites.ReadWrite.All Sites.ReadWrite.All
    Sites.Selected Sites.Search.All
    User.Export.All Sites.Selected
    User.Read TaskStatus.Submit
    User.Read.All TermStore.Read.All
    User.ReadWrite.All TermStore.Read.All
    TermStore.ReadWrite.All
    TermStore.ReadWrite.All
    User.Read.All
    User.Read.All
    User.ReadWrite.All
    User.ReadWrite.All
  6. Salve as alterações.
  7. Se você tiver escolhido usar permissões que exigem consentimento do administrador, poderá conceder essas permissões no locatário atual na página Permissões da API. A imagem a seguir mostra a página de permissões da API:
  8. Para adicionar o escopo, acesse a seção Exposiça uma API, adicione escopos AllSites.Manage, Sites.FullControl.All e selecione quem pode controlar (administradores e usuários). A imagem a seguir mostra a página "Expor uma API":
  9. Clique em Salvar.

Especifique as credenciais em Google Cloud

Ao criar a conexão nos Conectores de integração , especifique os seguintes detalhes:

Na seção Autenticação, selecione AzureAD como o tipo de autenticação e insira os seguintes detalhes:

  • ID do cliente: insira o ID do cliente usado para solicitar tokens de acesso.
  • Escopos: insira uma lista separada por vírgulas dos escopos desejados. Por exemplo, Sites.FullControl.All
  • Chave secreta do cliente: insira a chave secreta do cliente para o app conectado que você criou.
  • Versão do secret: versão do secret selecionada acima.
  • URL de autorização: é gerado quando você cria o cliente. Insira o URL no seguinte formato: https://login.microsoftonline.com/<tenant_identifier>/oauth2/v2.0/authorize. Por exemplo, https://login.microsoftonline.com/9bxxxxxxxxx8112/oauth2/v2.0/authorize.

Autorizar a conexão em Google Cloud

  1. Na página "Conexões", localize a conexão recém-criada.

    O Status do novo conector será Autorização necessária.

  2. Clique em Autorização necessária.

    O painel Editar autorização é mostrado.

  3. Copie o valor do URI de redirecionamento para seu aplicativo externo. Para mais informações, consulte Adicionar o URL de redirecionamento ao app.
  4. Verifique os detalhes da autorização.
  5. Clique em Autorizar.

    Se a autorização for bem-sucedida, o status da conexão será definido como Ativo na página "Conexões".

Adicionar o URL de redirecionamento ao app

  1. No portal do Azure, clique em Serviços do Azure > Registros de apps.
  2. Clique no nome do app.
  3. Clique em "Adicionar URI de redirecionamento".
  4. Clique em Adicionar uma plataforma.
  5. Na caixa de diálogo Web, cole o URI de redirecionamento que você copiou ao autorizar a conexão em Google Cloud.

Tipo de conexão do Azure AD

A tabela a seguir lista os valores de configuração de exemplo para o tipo de conexão do Azure AD:
Nome do campo Detalhes
Região us-central1
Conector SharePoint
Versão do conector 1
Nome da conexão sharepoint-google-cloud-con
Conta de serviço SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Número mínimo de nós 2
Número máximo de nós 50
Tipo de destino Endereço do host
host 1 http://z8**.sharepoint.com
Autenticação AzureAD
ID do cliente CLIENT_ID
Escopos Sites.FullControl.All
Chave secreta do cliente CLIENT_SECRET
Versão do secret 1
URL de autorização https://login.microsoftonline.com/{tenant-id}/oauth2/v2.0/authorize

OAuth 2.0: credenciais do cliente com o tipo de autenticação de portador JWT

Para ativar o OAuth 2.0 com o tipo de autenticação de portador JWT, siga estas etapas:
  1. Crie um certificado.
  2. Faça upload do certificado no portal do Azure.
  3. Receba uma chave privada.
  4. Conclua a configuração.
  5. Especifique as credenciais de portador do JWT OAuth 2.0 em Google Cloud.

Para ativar o tipo de autenticação de portador JWT, você precisa criar um certificado, fazer upload dele no portal do Azure e, em seguida, receber uma chave privada.

Criar um certificado

  1. Crie uma pasta vazia no computador.
  2. Crie um arquivo de texto na pasta.
  3. Copie o script do PowerShell da página Conceder acesso pela página somente para apps do Azure AD e cole no arquivo de texto.
  4. Renomeie o arquivo de texto para Create-SelfSignedCertificate.ps1.
  5. Execute o Windows PowerShell na pasta.
  6. Acesse o diretório que contém o arquivo de texto.
  7. Copie o seguinte comando: .\Create-SelfSignedCertificate.ps1 -CommonName "CERTIFICATE_NAME" -StartDate 2022-09-25 -EndDate 2023-10-25

    Insira um nome exclusivo para CERTIFICATE_NAME. Mude a StartDate para a data atual e a EndDate para a data que você quiser.

  8. Cole o comando copiado com suas alterações no Windows PowerShell e pressione Enter.

    O Windows PowerShell solicita a digitação da senha para proteger a chave privada. Salve a senha para uso futuro.

    O Windows PowerShell cria dois arquivos: MyCertificate.pfx e MyCertificate.cer.

Fazer upload do certificado no portal do Azure

  1. Faça login no portal do Azure e registre um novo aplicativo especificando os seguintes detalhes:
    • Nome: digite um nome para o aplicativo.
    • Tipos de conta com suporte: selecione Somente contas neste diretório organizacional (somente nome da conta - tenant único).
  2. Acesse Permissões de API > Adicionar permissão > Solicitar permissões de API > SharePoint.
  3. Selecione Permissões do app e adicione as permissões necessárias.
  4. Selecione Conceder consentimento do administrador e Sim.
  5. Depois de criar o app, navegue até a seção Certificados e segredos.
  6. Selecione Upload Certificate e faça upload do certificado CER do seu computador. Depois que o upload for concluído, selecione Adicionar.

    Não adicione chaves secretas do cliente no app, porque isso interfere no fluxo de autenticação baseado em certificado.

  7. Acesse o manifesto, encontre KeyCredentials e copie o customKeyIdentifier como Thumbprint. Você vai usar isso mais tarde. Você já registrou o app e vinculou o certificado.

Receber uma chave privada

É possível converter o arquivo PFX em um PEM usando o OpenSSL.

  1. No prompt de comando, acesse a pasta com o arquivo PFX e execute o seguinte comando: openssl pkcs12 -in MyCertificate.pfx -out MyCertificate.pem -nodes
  2. Digite a senha PFX que você usou no processo de criação do certificado.
  3. Abra o arquivo PEM em um editor de texto e copie a seguinte seção da chave privada: 
    -----BEGIN PRIVATE KEY----- 

-----END PRIVATE KEY-----

Concluir a configuração

  1. Copie o ID do cliente e do locatário do app recém-registrado no portal do Azure.
  2. Faça login com a autenticação de principal de serviço de lista do SharePoint usando as seguintes credenciais:
    • ID do cliente
    • Código do locatário
    • Chave privada
    • Thumbprint (senha de chave privada)

Especifique as credenciais de portador do JWT OAuth 2.0 em Google Cloud

Ao criar a conexão nos Conectores de integração , especifique os seguintes detalhes:

Na seção Autenticação, selecione Credenciais do cliente do OAuth 2.0 com o portador do JWT como o tipo de autenticação e insira os seguintes detalhes:

  • ID do cliente: insira o ID do cliente usado para solicitar tokens de acesso. Essa é a chave de consumidor gerada quando você registrou o app no portal do Azure.
  • Chave privada: selecione a chave secreta do Secret Manager que contém o conteúdo do arquivo de chave privada no formato PEM. A chave privada deve corresponder à chave pública/certificado fornecido ao conector.
  • Versão do secret: versão do secret selecionada acima.
  • Senha da chave privada: selecione o secret do Secret Manager que contém a senha (parafrase) do arquivo de chave privada.
  • Versão do secret: versão do secret selecionada acima.
  • Locatário do Azure: o locatário do Microsoft Online usado para acessar dados.

Tipo de conexão do certificado de portador JWT

A tabela a seguir lista os valores de configuração de exemplo para o tipo de conexão de certificado de portador JWT OAuth 2.0.
Nome do campo Detalhes
Região europe-west1
Conector SharePoint
Versão do conector 1
Nome da conexão sharepoint-jwt-certificate
Conta de serviço SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Número mínimo de nós 2
Número máximo de nós 50
Tipo de destino Endereço do host
host 1 http://z8**.sharepoint.com
porta 1 ****
Autenticação Credenciais do cliente OAuth 2.0 com portador JWT
ID do cliente OAuth CLIENT_ID
Chave privada CHAVE
Versão do secret 1
Senha de chave privada SENHA
Versão do secret 1
Azure Tenant AZURE_TENANT_ID

OAuth 2.0: tipo de conexão de chave secreta do cliente

Para ativar o tipo de conexão de chave secreta do cliente OAuth 2.0, siga estas etapas:

  1. Registre o complemento.
  2. Conceda permissões ao complemento.
  3. Especifique as credenciais do cliente OAuth 2.0 em Google Cloud
  4. Reautorização do código de autorização

Registrar o complemento

  1. Acesse a página Registrar complemento usando o seguinte URL: https://<SITE_NAME>.SharePoint.com/_layouts/15/appregnew.aspx.
  2. Na seção Informações do app, gere o ID e a chave secreta do cliente.
  3. Especifique valores para "Título", "Domínio do app" e "URI de redirecionamento".
  4. Clique em Criar.O complemento é registrado, e o app do SharePoint mostra as informações criadas.

Conceder permissões ao complemento

  1. Acesse o site do SharePoint usando o seguinte URL: https://<SITE_NAME>-admin.sharepoint.com/_layouts/15/appinv.aspx. Você será redirecionado para a página Conceder permissão.
  2. No campo ID do app, insira o ID do cliente que você gerou anteriormente e clique em Lookup. Os valores de "Título", "Domínio do app" e "URL de redirecionamento" são preenchidos.
  3. Insira a seguinte solicitação de permissão no formato XML: 
    <AppPermissionRequests AllowAppOnlyPolicy="true">
<AppPermissionRequest Scope="http://sharepoint/content/tenant" Right="FullControl"/>
</AppPermissionRequests>
  4. e clique em "Criar". O app Sharepoint mostra uma caixa de diálogo de consentimento de permissão.
  5. Clique em Confiar.

Especifique as credenciais do cliente OAuth 2.0 em Google Cloud

Ao criar a conexão nos Conectores de integração , especifique os seguintes detalhes:

Na seção Autenticação, selecione Credenciais do cliente do OAuth 2.0 com chave secreta do cliente como o tipo de autenticação e insira os seguintes detalhes:

  • ID do cliente: insira o ID do cliente fornecido pelo conector para o app que você criou.
  • Chave secreta do cliente: selecione o secret do Secret Manager que contém a chave secreta do cliente para o app conectado que você criou.
  • Versão do secret: selecione a versão do secret do cliente.

Reautorização do código de autorização

Se você usa o tipo de autenticação Authorization code e fez alterações de configuração no aplicativo SharePoint, será necessário autorizar novamente a conexão do SharePoint. Para autorizar novamente uma conexão, siga estas etapas:

  1. Clique na conexão necessária na página "Conexões".

    A página de detalhes da conexão será aberta.

  2. Clique em Editar para editar os detalhes da conexão.
  3. Verifique os detalhes do OAuth 2.0: código de autorização na seção Autenticação.

    Se necessário, faça as mudanças necessárias.

  4. Clique em Salvar. Isso leva você à página de detalhes da conexão.
  5. Clique em Edit authorization na seção Authentication. O painel Authorize é mostrado.
  6. Clique em Autorizar.

    Se a autorização for bem-sucedida, o status da conexão será definido como Ativo na página "Conexões".

Tipo de conexão de credenciais do cliente

A tabela a seguir lista os valores de configuração de exemplo para o tipo de conexão de credenciais do cliente OAuth 2.0.
Nome do campo Detalhes
Região europe-west1
Conector SharePoint
Versão do conector 1
Nome da conexão sharepoint-client-credentials
Conta de serviço SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Número mínimo de nós 2
Número máximo de nós 50
Tipo de destino Endereço do host
host 1 http://z8**.sharepoint.com
porta 1 ****
Autenticação Credenciais do cliente OAuth 2.0 com chave secreta do cliente
ID do cliente CLIENT_ID
Chave secreta do cliente CLIENT_SECRET
Versão do secret 1

Entidades, operações e ações

Todos os Integration Connectors fornecem uma camada de abstração para os objetos do aplicativo conectado. Só é possível acessar os objetos de um aplicativo por esta abstração. A abstração é exposta a você como entidades, operações e ações.

  • Entidade: uma entidade pode ser considerada um objeto ou um conjunto de propriedades no aplicativo ou serviço conectado. A definição de uma entidade difere de um conector para outro. Por exemplo, em um conector de banco de dados, as tabelas são as entidades, em um conector de servidor de arquivos, as pastas são as entidades e, em um conector de sistema de mensagens, as filas são as entidades.

    No entanto, é possível que um conector não aceite ou não tenha entidades. Nesse caso, a lista Entities estará vazia.

  • Operação: uma operação é a atividade que pode ser realizada em uma entidade. É possível executar qualquer uma das seguintes operações em uma entidade:

    Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para ela. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa "Conectores". No entanto, se um conector não oferecer suporte a nenhuma das operações de entidade, essas operações sem suporte não serão listadas na lista Operations.

  • Ação: uma ação é uma função de primeira classe disponibilizada para a integração por meio da interface do conector. Uma ação permite fazer alterações em uma ou mais entidades e varia de um conector para outro. Normalmente, uma ação tem alguns parâmetros de entrada e um de saída. No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

Ações

Esta seção lista algumas das ações aceitas pelo conector. Para entender como configurar as ações, consulte Exemplos de ação.

Ação "DeleteAttachment"

Essa ação exclui um anexo.

Parâmetros de entrada da ação DeleteAttachment

Nome do parâmetro Tipo de dados Obrigatório Descrição
ListTitle String Sim Título do item da lista.
ItemId String Sim ID do item da lista.
FileName String Sim Nome do arquivo a ser excluído da biblioteca de documentos.

Para entender como configurar a ação DeleteAttachment, consulte Exemplos de ação.

Ação CheckInDocument

Com essa ação, você pode enviar um documento.

Parâmetros de entrada da ação CheckInDocument

Nome do parâmetro Tipo de dados Obrigatório Descrição
RelativeURL String Sim URL relativo da pasta.
DocumentName String Sim Nome do arquivo a ser enviado.
Comentário String Não Uma mensagem de check-in opcional.

Para entender como configurar a ação CheckInDocument, consulte Exemplos de ação.

Ação CheckOutDocument

Essa ação permite que você retire um arquivo.

Parâmetros de entrada da ação CheckOutDocument

Nome do parâmetro Tipo de dados Obrigatório Descrição
RelativeURL String Sim URL relativo da pasta.
DocumentName String Sim Nome do arquivo a ser retirado.

Para entender como configurar a ação CheckOutDocument, consulte Exemplos de ação.

Ação DiscardCheckOutDocument

Essa ação permite desfazer a retirada de um arquivo.

Parâmetros de entrada da ação DiscardCheckOutDocument

Nome do parâmetro Tipo de dados Obrigatório Descrição
RelativeURL String Sim URL relativo da pasta.
DocumentName String Sim Nome do arquivo para o qual a retirada precisa ser desfeita.

Para entender como configurar a ação DiscardCheckOutDocument, consulte Exemplos de ação.

Ação CopyDocument

Com essa ação, você pode copiar um arquivo de um local para outro.

Parâmetros de entrada da ação CopyDocument

Nome do parâmetro Tipo de dados Obrigatório Descrição
SourceFileRelativeUrl String Sim URL relativo do arquivo de origem.
DestFileRelativeUrl String Sim URL relativo do arquivo de destino.

Para entender como configurar a ação CopyDocument, consulte Exemplos de ação.

Ação UploadDocument

Essa ação permite fazer upload de um arquivo.

Parâmetros de entrada da ação UploadDocument

Nome do parâmetro Tipo de dados Obrigatório Descrição
FileName String Sim Nome do arquivo a ser enviado.
RelativeUrl String Sim URL relativo da pasta.
Conteúdo String Não Conteúdo a ser enviado como um arquivo.
ContentBytes String Não Conteúdo de bytes (como uma string Base64) para fazer upload como um arquivo. Use para fazer upload de dados binários.
HasBytes Booleano Não Especifica se o conteúdo a ser enviado é binário. O valor padrão é false.

Para entender como configurar a ação UploadDocument, consulte Exemplos de ação.

Ação DownloadDocument

Essa ação permite fazer o download de um arquivo.

Parâmetros de entrada da ação DownloadDocument

Nome do parâmetro Tipo de dados Obrigatório Descrição
RemoteFile String Sim URL completo do arquivo a ser feito o download.
Biblioteca String Sim Nome da biblioteca no servidor do SharePoint.
HasBytes Booleano Não Especifica se o conteúdo precisa ser transferido por download como bytes. O valor padrão é false.

Para entender como configurar a ação DownloadDocument, consulte Exemplos de ação.

Ação MoveAttachmentOrDocument

Essa ação permite mover um arquivo de uma pasta para outra.

Parâmetros de entrada da ação MoveAttachmentOrDocument

Nome do parâmetro Tipo de dados Obrigatório Descrição
SourceFileURL String Sim URL do arquivo de origem que precisa ser movido.
DestinationFolderURL String Sim URL da pasta de destino.

Para entender como configurar a ação MoveAttachmentOrDocument, consulte Exemplos de ação.

Ação "CreateFolder"

Essa ação permite criar uma pasta.

Parâmetros de entrada da ação CreateFolder

Nome do parâmetro Tipo de dados Obrigatório Descrição
RelativeURL String Sim URL relativo da pasta.
FolderName String Sim Nome da pasta a ser criada.

Para entender como configurar a ação CreateFolder, consulte Exemplos de ação.

Ação "AddAttachments"

Com essa ação, você pode adicionar um anexo.

Parâmetros de entrada da ação AddAttachments

Nome do parâmetro Tipo de dados Obrigatório Descrição
ListTitle String Sim Nome da lista de anexos.
FileName String Sim Nome do arquivo anexo.
ItemId String Sim ID do anexo a ser adicionado.
Conteúdo String Sim Conteúdo do anexo.
ContentBytes String Não Conteúdo de bytes (como uma string Base64) para fazer upload como um anexo. Use para fazer upload de dados binários.
HasBytes Booleano Não Especifica se o conteúdo a ser enviado é binário. O valor padrão é false.

Para entender como configurar a ação AddAttachments, consulte Exemplos de ação.

Ação DownloadAttachments

Com essa ação, você pode fazer o download de anexos.

Parâmetros de entrada da ação DownloadAttachments

Nome do parâmetro Tipo de dados Obrigatório Descrição
RemoteFile String Sim URL relativo do arquivo.
HasBytes Booleano Não Especifica se o conteúdo a ser transferido por download é binário. O valor padrão é false.

Para entender como configurar a ação DownloadAttachments, consulte Exemplos de ação.

Exemplos de ação

Esta seção descreve como realizar algumas das ações neste conector.

Exemplo: excluir um anexo

Este exemplo exclui o arquivo especificado.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação DeleteAttachment e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"ListTitle": "My lists",
"ItemId": "1",
"FileName": "sitepages.txt"
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa DeleteAttachment terá um valor semelhante a este:

    [{
"Status": "Success"
}]

Exemplo: verificar um documento

Este exemplo faz o check-in de um documento.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CheckInDocument e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.txt",
"Comment": "Comment test"
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa CheckInDocument terá um valor semelhante a este:

    [{
"Status": "Success"
}]

Exemplo: retirar um arquivo

Este exemplo retira um arquivo.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CheckOutDocument e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.txt"
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa CheckOutDocument terá um valor semelhante a este:

    [{
"Status": "Success"
}]

Exemplo: descartar um check-out

Este exemplo reverte o check-out de um arquivo.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação DiscardCheckOutDocument e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.docx"
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa DiscardCheckOutDocument terá um valor semelhante a este:

    [{
"Status": "Success"
}]

Exemplo: copiar um arquivo

Este exemplo copia um arquivo de um local para outro.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CopyDocument e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"SourceFileRelativeUrl": "/Shared Documents/Document.docx",
"DestFileRelativeUrl": "/Shared Documents/TestFolder/Document123.docx"
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa CopyDocument terá um valor semelhante a este:

    [{
"Status": "Success"
}]

Exemplo: fazer upload de um arquivo de texto

Este exemplo faz o upload de um arquivo de texto para o local especificado.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação UploadDocument e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"FileName": "test.txt",
"RelativeUrl": "/Shared Documents/TestFolder",
"Content": "abcd"
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa UploadDocument terá um valor semelhante a este:

    [{
"Status": "Success"
}]

Exemplo: fazer upload de um arquivo binário

Este exemplo faz o upload de um arquivo binário para o local especificado. Ao fazer upload de um arquivo binário, especifique o conteúdo a ser enviado como uma string codificada em Base64.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação UploadDocument e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"FileName": "test.txt",
"RelativeUrl": "/Shared Documents/TestFolder",
"ContentBytes": "SGVsbG8gd29ybGQK",
"HasBytes": "true"
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa UploadDocument terá um valor semelhante a este:

    [{
"Status": "Success"
}]

Exemplo: fazer o download de um arquivo

Este exemplo faz o download de um arquivo.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação DownloadDocument e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"RemoteFile": "/TestFolder/test.txt",
"Library": "Shared Documents"
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa DownloadDocument terá um valor semelhante a este:

    [{
"Success": "True",
"Content": "Test File",
}]

Exemplo: fazer o download de um arquivo binário

Este exemplo faz o download de um arquivo binário.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação DownloadDocument e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"RemoteFile": "/TestFolder/test1.png",
"Library": "Shared Documents"
"HasBytes": "true"  
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa DownloadDocument terá um valor semelhante a este:

    [{
"Success": "True",
"ContentBytes": "VGVzdCBGaWxl",
}]

Exemplo: mover um anexo

Neste exemplo, um anexo é movido de um local para outro.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação MoveAttachmentOrDocument e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"SourceFileURL": "/Shared Documents/test.txt",
"DestinationFolderURL": "/Shared Documents/TestFolder"
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa MoveAttachmentOrDocument terá um valor semelhante a este:

    [{
"Result": "Success"
}]

Exemplo: criar uma pasta

Este exemplo cria uma pasta no local especificado.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CreateFolder e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"RelativeURL": "/Shared Documents/TestFolder",
"FolderName": "TestFolder123"
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa CreateFolder terá um valor semelhante a este:

    [{
"Id": "110842b7-2393-4f11-9391-3d75214e9fb8",
"Status": "Success"
}]

Exemplo: adicionar um anexo

Este exemplo adiciona um anexo à lista especificada.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação AddAttachments e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"ListTitle": "My Lists",
"FileName": "TestAttachment2",
"Content": "abcd text",
"ItemId": "1"
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa AddAttachments terá um valor semelhante a este:

    [{
"RelativeUrl": "/Lists/My lists/Attachments/1/TestAttachment2",
"Status": "Success"
}]

Exemplo: adicionar um anexo binário

Este exemplo adiciona um anexo binário à lista especificada.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação AddAttachments e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"ListTitle": "My Lists",
"FileName": "TestAttachment3",
"ContentBytes": "VGVzdCBGaWxl",
"HasBytes": "true",  
"ItemId": "1"
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa AddAttachments terá um valor semelhante a este:

    [{
"RelativeUrl": "/Lists/My lists/Attachments/1/TestAttachment3",
"Status": "Success"
}]

Exemplo: fazer o download de um anexo

Este exemplo faz o download de um anexo.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação DownloadAttachments e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"RemoteFile": "/Shared Documents/Document.txt"
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa DownloadAttachments terá um valor semelhante a este:

    [{
"Success": "True",
"Content": "Test File",
}]

Exemplo: fazer o download de um anexo binário

Este exemplo faz o download de um anexo binário.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação DownloadAttachments e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"RemoteFile": "/Shared Documents/Document.docx",
"HasBytes": "true"
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa DownloadAttachments terá um valor semelhante a este:

    [{
"Success": "True",
"ContentBytes": "VGVzdCBGaWxl",
}]

Exemplos de operação de entidade

Esta seção mostra como realizar algumas das operações de entidade neste conector.

Exemplo: listar todos os arquivos

Este exemplo lista todos os arquivos na entidade Files.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Files na lista Entity.
  3. Selecione a operação List e clique em Concluído.
  4. Opcionalmente, na seção Entrada de tarefa da tarefa Conectores, é possível filtrar o conjunto de resultados especificando uma cláusula de filtro. Também é possível especificar várias condições de filtro usando os operadores lógicos.

Exemplo: acessar uma lista

Este exemplo recebe uma lista com o ID especificado da entidade My Lists.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione My Lists na lista Entity.
  3. Selecione a operação Get e clique em Concluído.
  4. Na seção Entrada da tarefa da tarefa Connectors, clique em EntityId e insira 3 no campo Valor padrão.

    Aqui, 3 é um valor de chave primária na entidade My Lists.

Exemplo: criar um registro

Este exemplo cria um registro na entidade My Lists.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione My Lists na lista Entity.
  3. Selecione a operação Create e clique em Concluído.
  4. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"AuthorId": 11.0, 
"BaseName": "3_",
"Attachments": false,
"Title": "Created List New"
}

    Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

    [{
"ID": 3.0
}]

Exemplo: excluir um registro

Este exemplo exclui o registro com o ID especificado na entidade My Lists.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione My Lists na lista Entity.
  3. Selecione a operação Delete e clique em Concluído.
  4. Na seção Entrada da tarefa da tarefa Connectors, clique em entityId e insira 2 no campo Valor padrão.

Usar a conexão do SharePoint em uma integração

Depois de criar a conexão, ela fica disponível na integração da Apigee e na integração do aplicativo. É possível usar a conexão em uma integração pela tarefa de conectores.

  • Para entender como criar e usar a tarefa "Connectors" na integração da Apigee, consulte Tarefa Connectors.
  • Para entender como criar e usar a tarefa "Conectores" na integração de aplicativos, consulte Tarefa "Conectores".

Receber ajuda da comunidade do Google Cloud

Poste suas dúvidas e converse sobre esse conector na comunidade do Google Cloud em Fóruns do Cloud.

A seguir