SharePoint

O conetor do SharePoint permite-lhe gerir ficheiros, pastas e anexos no SharePoint.

Versões suportadas

Este conetor suporta o Windows SharePoint Services 3.0, o Microsoft Office SharePoint Server 2007 e superior, e o SharePoint Online.

Antes de começar

No seu projeto do Google Cloud, faça as seguintes tarefas:

• Certifique-se de que a conetividade de rede está configurada. Para mais informações, consulte o artigo Conetividade de rede.
• Conceda a função IAM roles/connectors.admin ao utilizador que está a configurar o conetor.
• Conceda funções de IAM roles/secretmanager.viewer e roles/secretmanager.secretAccessor à conta de serviço que quer usar para o conector:
• Ative a secretmanager.googleapis.com (API Secret Manager) e a connectors.googleapis.com (API Connectors). Para mais informações, consulte o artigo Ativar serviços.

Crie uma ligação ao SharePoint

Uma associação é específica de uma origem de dados. Isto significa que, se tiver muitas origens de dados, tem de criar uma associação separada para cada origem de dados. Para criar uma associação, faça o seguinte:

1. Na Cloud Console, aceda à página Integration Connectors > Ligações e, de seguida, selecione ou crie um projeto do Google Cloud.

   Aceda à página Ligações

2. Clique em + Criar novo para abrir a página Criar associação.
3. Na secção Localização, selecione uma localização na lista Região e, de seguida, clique em Seguinte.

   Para ver a lista de todas as regiões suportadas, consulte o artigo Localizações.

4. Na secção Detalhes da ligação, conclua o seguinte:
   1. Selecione SharePoint na lista de conetores.
   2. Selecione uma versão do conetor na lista Versão do conetor.
   3. No campo Nome da associação, introduza um nome para a instância de associação. O nome da associação pode conter letras minúsculas, números ou hífenes. O nome tem de começar com uma letra e terminar com uma letra ou um número, e não pode exceder os 49 carateres.
   4. Opcionalmente, introduza uma Descrição para a instância de associação.
   5. Opcionalmente, ative o Registo na nuvem e, em seguida, selecione um nível de registo. Por predefinição, o nível do registo está definido como Error.
   6. No campo Conta de serviço, selecione uma conta que tenha as funções necessárias.
   7. Opcionalmente, configure as definições do nó de associação:
      • Número mínimo de nós: introduza o número mínimo de nós de ligação.
      • Número máximo de nós: introduza o número máximo de nós de ligação.

      Um nó é uma unidade (ou uma réplica) de uma ligação que processa transações. São necessários mais nós para processar mais transações para uma ligação e, inversamente, são necessários menos nós para processar menos transações. Para compreender como os nós afetam os preços dos conectores, consulte o artigo Preços dos nós de ligação. Se não introduzir valores, por predefinição, os nós mínimos são definidos como 2 (para uma melhor disponibilidade) e os nós máximos são definidos como 50.

   Nota: só pode personalizar os valores dos nós de associação se for cliente de pagamento conforme o uso.
   8. Opcionalmente, clique em + Adicionar etiqueta para adicionar uma etiqueta à associação sob a forma de um par chave/valor.
   9. Clicar em Seguinte.
5. Na secção Destinos, introduza os detalhes do anfitrião remoto (sistema de back-end) ao qual quer estabelecer ligação e clique em Seguinte.

No campo Tipo de destino, selecione um tipo de destino. Por exemplo, o endereço do anfitrião é https://<SITE_NAME>.sharepoint.com.

• Para especificar o nome de anfitrião ou o endereço IP de destino, selecione Endereço do anfitrião e introduza o endereço no campo Anfitrião 1.
• Para estabelecer uma ligação privada, selecione Anexo do ponto final e escolha o anexo necessário na lista Anexo do ponto final.
  Nota: para saber como criar uma associação de ponto final, consulte Associação de serviço do PSC e Associação de ponto final. Depois de criar a associação do ponto final, esta fica visível na lista Associação do ponto final.

Se quiser estabelecer uma ligação pública aos seus sistemas de back-end com segurança adicional, pode considerar configurar endereços IP estáticos de saída para as suas ligações e, em seguida, configurar as regras da firewall para permitir apenas os endereços IP estáticos específicos.

Para introduzir destinos adicionais, clique em +Adicionar destino.

6. Na secção Autenticação, introduza os detalhes de autenticação.
   1. Selecione um Tipo de autenticação e introduza os detalhes relevantes.

      Os seguintes tipos de autenticação são suportados pela ligação do SharePoint:

      • Credenciais do Windows. Selecione esta opção se usar a edição nas instalações do SharePoint.
      • AzureAD. Selecione esta opção se usar a edição online do SharePoint.
      • Credenciais de cliente OAuth 2.0 com portador JWT. Selecione esta opção se usar credenciais de cliente OAuth 2.0 com portador JWT para autenticação.
      • Credenciais do cliente OAuth 2.0 com segredo do cliente. Selecione esta opção se usar credenciais de cliente OAuth 2.0 com o segredo do cliente para autenticação.

   Para saber como configurar estes tipos de autenticação, consulte o artigo Configurar autenticação.

   2. Clicar em Seguinte.
7. Na secção Rever, reveja os detalhes de ligação e autenticação.
8. Clique em Criar.

Configure a autenticação

O conector do SharePoint suporta 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, tem de concluir os seguintes passos:

1. Configure o PSC e crie uma associação de ponto final.
2. Especifique as credenciais em Google Cloud.

Configure o PSC e crie uma associação de ponto final

1. Crie um grupo de instâncias com o IP onde o SharePoint está alojado.
2. Crie um equilibrador de carga de passagem interno e use o grupo de instâncias que criou como back-end. O balanceador de carga interno de TCP tem de ter o acesso global ativado.
3. Publique o balanceador de carga no Private Service Connect. É gerado um anexo de serviço após a publicação do balanceador de carga.
4. Publique o serviço e especifique o equilibrador de carga que criou.
5. Use a associação de serviço para criar uma associação de ponto final.
6. Depois de criar a associação do ponto final, crie uma associação do SharePoint com o IP da associação do ponto final.

Para mais informações sobre como criar uma associação de pontos finais, consulte o artigo Crie uma associação de pontos finais.

Especifique os detalhes das credenciais do Windows em Google Cloud

Quando cria a ligação nos Integration Connectors , tem de especificar os seguintes detalhes:

Na secção Autenticação, selecione Credenciais do Windows como o tipo de autenticação e, de seguida, introduza os seguintes detalhes:

• Nome de utilizador: introduza o nome de utilizador.
• Palavra-passe: selecione a palavra-passe.
• Versão do Secret: introduza a versão do Secret.

Tipo de ligação de credenciais do Windows

A tabela seguinte apresenta os valores de configuração de exemplo para o tipo de ligação de credenciais do Windows.

Nome do campo	Detalhes
Região	us-central1
Conetor	SharePoint
Versão do conetor	1
Nome da ligaçã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	Morada do anfitrião
anfitrião 1	http://192.0.2.0
porta 1	24
Autenticação	Credenciais do Windows
Nome de utilizador	USER_NAME
Palavra-passe	PASSWORD
Versão do Secret	1

Tipo de autenticação do Azure AD

Para ativar o tipo de autenticação do Azure AD, tem de concluir os seguintes passos:

1. Registe a sua app e obtenha o OAuthClientId e o OAuthClientSecret.
2. Especifique as credenciais em Google Cloud.
3. Autorize a associação em Google Cloud.
4. Adicione o URL de redirecionamento à sua app.

Registe a sua app e obtenha o OAuthClientId e o OAuthClientSecret

Para registar a sua app e obter o OAuthClientId e o OAuthClientSecret para a mesma, faça o seguinte:

1. Inicie sessão no portal do Azure.
2. Em Serviços Azure, selecione Registos de apps e, de seguida, Novo registo.
3. Introduza um nome de aplicação e selecione Qualquer inquilino do Microsoft Entra ID – Vários inquilinos.
4. Clique em Registar.
5. Depois de criar a app, navegue para a página Certificados e segredos.
6. Crie um segredo do cliente para a aplicação e guarde o valor do segredo do cliente.
7. Navegue para a página Autorizações da API.
8. Clique em Adicionar uma autorização.
9. Na caixa de diálogo Pedir autorizações da API, selecione a API, o tipo e as autorizações na tabela seguinte para realizar operações na aplicação.

Para que a associação esteja ativa, tem de conceder autorização Sites.Read.All à API Microsoft Graph.

API	Nome das autorizações	Tipo
Microsoft Graph	ConsentRequest.Read.All	Application/ Delegated
Microsoft Graph	ConsentRequest.ReadWrite.All	Application/ Delegated
Microsoft Graph	DelegatedAdminRelationship.Read.All	Application/ Delegated
Microsoft Graph	DelegatedAdminRelationship.ReadWrite.All	Application/ Delegated
Microsoft Graph	DelegatedPermissionGrant.Read.All	Application/ Delegated
Microsoft Graph	DelegatedPermissionGrant.ReadWrite.All	Application/ Delegated
Microsoft Graph	Files.Read.All	Application/ Delegated
Microsoft Graph	Files.ReadWrite.All	Application/ Delegated
Microsoft Graph	Sites.FullControl.All	Application/ Delegated
Microsoft Graph	Sites.Manage.All	Application/ Delegated
Microsoft Graph	Sites.Read.All	Application/ Delegated
Microsoft Graph	Sites.ReadWrite.All	Application/ Delegated
Microsoft Graph	Sites.Selected	Application/ Delegated
Microsoft Graph	TermStore.Read.All	Application/ Delegated
Microsoft Graph	TermStore.ReadWrite.All	Application/ Delegated
Microsoft Graph	User.Export.All	Application/ Delegated
Microsoft Graph	User.Read	Delegated
Microsoft Graph	User.Read.All	Application/ Delegated
Microsoft Graph	User.ReadWrite.All	Application/ Delegated
SharePoint	EnterpriseResource.Read	Delegated
SharePoint	EnterpriseResource.Write	Delegated
SharePoint	Project.Read	Delegated
SharePoint	Project.Write	Delegated
SharePoint	ProjectWebApp.FullControl	Delegated
SharePoint	ProjectWebAppReporting.Read	Delegated
SharePoint	TaskStatus.Submit	Delegated

10. Guarde as alterações.
11. Se selecionou a utilização de autorizações que requerem o consentimento do administrador, pode concedê-las a partir do inquilino atual na página Autorizações da API.
12. Para adicionar o âmbito, aceda à secção Expor uma API, adicione AllSites.Manage, Sites.FullControl.All âmbitos e selecione quem pode controlar (administradores e utilizadores).
13. Clique em Guardar.

Especifique as credenciais em Google Cloud

Quando cria a ligação nos Integration Connectors , tem de especificar os seguintes detalhes:

Na secção Autenticação, selecione AzureAD como o tipo de autenticação e, de seguida, introduza os seguintes detalhes:

• ID de cliente: introduza o ID de cliente usado para pedir tokens de acesso.
• Âmbitos: introduza uma lista de âmbitos desejados separada por vírgulas. Por exemplo, Sites.FullControl.All
• Segredo do cliente: introduza o segredo que contém o segredo do cliente para a app associada que criou.
• Versão do Secret: versão do Secret para o Secret selecionado acima.
• URL de autorização: o URL de autorização que gera quando cria um cliente OAuth. Introduza o URL no seguinte formato: https://login.microsoftonline.com/TENANT_IDENTIFIER/oauth2/v2.0/authorize?prompt=consent. Por exemplo, https://login.microsoftonline.com/9byyyyyyyyy8112/oauth2/v2.0/authorize?prompt=consent.

Autorize a associação no Google Cloud

1. Na página Ligações, encontre a ligação criada recentemente.

   O Estado do novo conector é Autorização necessária.

2. Clique em Autorização obrigatória.

   É apresentado o painel Editar autorização.

3. Copie o valor do URI de redirecionamento para a sua aplicação externa. Para mais informações, consulte o artigo Adicione o URL de redirecionamento à sua app.
4. Valide os detalhes da autorização.
5. Clique em Autorizar.

   Se a autorização for bem-sucedida, o estado da ligação é definido como Ativo na página Ligações.

Adicione o URL de redirecionamento à sua app

1. No portal do Azure, clique em Serviços do Azure > Registos de apps.
2. Clique no nome da 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 copiou quando autorizou a ligação em Google Cloud.

Tipo de ligação do Azure AD

A tabela seguinte apresenta os valores de configuração de exemplo para o tipo de ligação do Azure AD:

Nome do campo	Detalhes
Região	us-central1
Conetor	SharePoint
Versão do conetor	1
Nome da ligaçã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	Morada do anfitrião
anfitrião 1	http://z8**.sharepoint.com
Autenticação	AzureAD
ID do cliente	CLIENT_ID
Âmbitos	Sites.FullControl.All
Segredo 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 de cliente com tipo de autenticação de portador JWT

Para ativar o OAuth 2.0 – credenciais do cliente com o tipo de autenticação de portador JWT, tem de concluir os seguintes passos:

1. Crie um certificado.
2. Carregue o certificado para o portal do Azure.
3. Obtenha uma chave privada.
4. Conclua a configuração.
5. Especifique as credenciais do portador do JWT do OAuth 2.0 em Google Cloud.

Crie um certificado

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

   Introduza um nome exclusivo para CERTIFICATE_NAME. Altere a StartDate para a data atual e a EndDate para uma data à sua escolha.

8. Cole o comando copiado com as suas alterações no Windows PowerShell e, em seguida, prima Enter.

   O Windows PowerShell pede-lhe para introduzir a palavra-passe para proteger a chave privada. Certifique-se de que guarda a palavra-passe para utilização posterior.

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

Carregue o certificado para o portal do Azure

1. Inicie sessão no portal do Azure e registe uma nova aplicação especificando os seguintes detalhes:
   • Nome: introduza um nome para a aplicação.
   • Tipos de contas suportados: selecione Apenas contas neste diretório organizacional (apenas nome da conta – inquilino único).
2. Aceda a Autorizações da API > Adicionar autorização > Pedir autorizações da API > SharePoint.
3. Selecione Autorizações da aplicação e, de seguida, adicione as autorizações necessárias.
4. Selecione Conceder consentimento do administrador e, de seguida, selecione Sim.
5. Depois de criar a app, navegue para a secção Certificados e segredos.
6. Selecione Carregar certificado e, em seguida, carregue o certificado CER a partir do computador. Após a conclusão do carregamento, selecione Adicionar.

   Não adicione segredos do cliente na app, uma vez que interferem com o fluxo de autenticação com base em certificados.

7. Aceda a Manifesto, encontre KeyCredentials e, em seguida, copie o customKeyIdentifier como a impressão digital. Vai usá-lo mais tarde. Já registou a app e associou o certificado.

Obtenha uma chave privada

Pode obter uma chave privada convertendo o ficheiro PFX num ficheiro PEM através do OpenSSL.

1. Na linha de comandos, aceda à pasta com o ficheiro PFX e execute o seguinte comando: openssl pkcs12 -in MyCertificate.pfx -out MyCertificate.pem -nodes
2. Introduza a palavra-passe PFX que usou no processo de criação do certificado.
3. Abra o ficheiro PEM num editor de texto e copie todo o texto, que é a sua chave privada.

Conclua a configuração

1. Copie o ID de cliente e o ID de inquilino da app recém-registada no portal do Azure.
2. Inicie sessão com a autenticação do principal de serviço da lista do SharePoint com as seguintes credenciais:
• ID do cliente
• ID do inquilino
• Chave privada
• Thumbprint (palavra-passe da chave privada)

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

Quando cria a ligação nos Integration Connectors , tem de especificar os seguintes detalhes:

Na secção Autenticação, selecione Credenciais de cliente OAuth 2.0 com token de portador JWT como o tipo de autenticação e, de seguida, introduza os seguintes detalhes:

• No campo ID de cliente, introduza o ID de cliente usado para pedir tokens de acesso. Esta é a chave do consumidor gerada quando registou a app no portal do Azure.
• No campo Chave privada, selecione o segredo do Secret Manager que contém o conteúdo do ficheiro de chave privada no formato PEM. A chave privada deve corresponder à chave pública/certificado fornecido ao conector.
• No campo Versão do Secret, selecione a versão do Secret selecionado acima.
• No campo Palavra-passe da chave privada, selecione o segredo do gestor de segredos que contém a palavra-passe (paráfrase) do ficheiro de chave privada. Use a mesma palavra-passe que definiu para proteger a chave privada quando criou o certificado.
• No campo Versão do Secret, selecione a versão do Secret selecionado acima.
• No campo Inquilino do Azure, introduza o inquilino online da Microsoft que está a ser usado para aceder aos dados.

Tipo de ligação de certificado de portador JWT

A tabela seguinte apresenta os valores de configuração de exemplo para o tipo de ligação de certificado portador de JWT do OAuth 2.0.

Nome do campo	Detalhes
Região	europe-west1
Conetor	SharePoint
Versão do conetor	1
Nome da ligaçã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	Morada do anfitrião
anfitrião 1	http://z8**.sharepoint.com
porta 1	****
Autenticação	Credenciais de cliente OAuth 2.0 com portador JWT
ID de cliente OAuth	CLIENT_ID
Chave privada	LEGENDA
Versão do Secret	1
Palavra-passe da chave privada	PASSWORD
Versão do Secret	1
Inquilino do Azure	AZURE_TENANT_ID

OAuth 2.0 – Tipo de ligação de segredo do cliente

Para ativar o tipo de ligação de segredo do cliente OAuth 2.0, tem de concluir os seguintes passos:

1. Registe o suplemento.
2. Conceda autorizações ao suplemento.
3. Especifique as credenciais de cliente OAuth 2.0 em Google Cloud
4. Reautorização para o código de autorização

Registe o suplemento

1. Navegue para a página Registar suplemento através do seguinte URL: https://<SITE_NAME>.SharePoint.com/_layouts/15/appregnew.aspx.
2. Na secção Informações da app, gere o ID do cliente e o segredo do cliente.
3. Especifique valores para Título, Domínio da app e URI de redirecionamento.
4. Clique em Criar.O suplemento é registado e a app SharePoint apresenta as informações criadas.

Conceda autorizações ao suplemento

1. Navegue para o site do SharePoint através do seguinte URL: https://<SITE_NAME>-admin.sharepoint.com/_layouts/15/appinv.aspx. É feito o redirecionamento para a página Conceder autorização.
2. No campo ID da app, introduza o ID de cliente que gerou anteriormente e clique em Pesquisar. Os valores de Título, Domínio da app e URL de redirecionamento são preenchidos.
3. Introduza o seguinte pedido de autorização no formato XML:

         <AppPermissionRequests AllowAppOnlyPolicy="true">
         <AppPermissionRequest Scope="http://sharepoint.com/content/tenant" Right="FullControl"/>
         </AppPermissionRequests>
           

4. Clique em Criar. A app Sharepoint apresenta uma caixa de diálogo de consentimento de autorização.
5. Clique em Confiar.

Especifique as credenciais de cliente OAuth 2.0 em Google Cloud

Quando cria a ligação nos Integration Connectors, tem de especificar os seguintes detalhes:

Na secção Autenticação, selecione Credenciais do cliente OAuth 2.0 com segredo do cliente como o tipo de autenticação e, de seguida, introduza os seguintes detalhes:

• No campo ID de cliente, introduza o ID de cliente fornecido pelo conector para a app que criou.
• No campo Segredo do cliente, selecione o segredo do Secret Manager que contém o segredo do cliente da app associada que criou.
• No campo Versão do segredo, selecione a versão do segredo do cliente.

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

Se usar o tipo de autenticação Authorization code e tiver feito alterações de configuração na sua aplicação SharePoint, tem de voltar a autorizar a ligação ao SharePoint. Para autorizar novamente uma associação, siga estes passos:

1. Clique na associação necessária na página Associações.

   É apresentada a página de detalhes da associação.

2. Clique em Editar para editar os detalhes da associação.
3. Valide os detalhes de OAuth 2.0 – Código de autorização na secção Autenticação.

   Se necessário, faça as alterações necessárias.

4. Clique em Guardar. Esta ação direciona para a página de detalhes da associação.
5. Clique em Editar autorização na secção Autenticação. É apresentado o painel Autorizar.
6. Clique em Autorizar.

   Se a autorização for bem-sucedida, o estado da ligação é definido como Ativo na página Ligações.

Tipo de ligação de credenciais do cliente

A tabela seguinte apresenta os valores de configuração de exemplo para o tipo de ligação de credenciais de cliente OAuth 2.0.

Nome do campo	Detalhes
Região	europe-west1
Conetor	SharePoint
Versão do conetor	1
Nome da ligaçã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	Morada do anfitrião
anfitrião 1	http://z8**.sharepoint.com
porta 1	****
Autenticação	Credenciais de cliente OAuth 2.0 com segredo do cliente
ID do cliente	CLIENT_ID
Segredo do cliente	CLIENT_SECRET
Versão do Secret	1

Use a associação do SharePoint numa integração

Depois de criar a ligação, esta fica disponível no Apigee Integration e no Application Integration. Pode usar a ligação numa integração através da tarefa Conectores.

Ações

Esta secção apresenta algumas das ações suportadas pelo conetor. Para compreender como configurar as ações, consulte os exemplos de ações.

Nota: os resultados de todas as ações vão estar disponíveis como uma resposta JSON no parâmetro de resposta da tarefa ConnectorsconnectorOutputPayload após executar a integração.

Ação DeleteAttachment

Esta ação elimina um anexo.

Parâmetros de entrada da ação DeleteAttachment

Nome do parâmetro	Tipo de dados	Obrigatória	Descrição
ListTitle	String	Sim	Título do elemento da lista.
ItemId	String	Sim	ID do elemento da lista.
FileName	String	Sim	Nome do ficheiro a eliminar da biblioteca de documentos.

Ação CheckInDocument

Esta ação permite-lhe fazer o check-in num documento.

Introduza os parâmetros da ação CheckInDocument

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

Ação CheckOutDocument

Esta ação permite-lhe retirar um ficheiro.

Introduza os parâmetros da ação CheckOutDocument

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

Ação DiscardCheckOutDocument

Esta ação permite anular a obtenção de um ficheiro.

Parâmetros de entrada da ação DiscardCheckOutDocument

Nome do parâmetro	Tipo de dados	Obrigatória	Descrição
RelativeURL	String	Sim	URL relativo da pasta.
DocumentName	String	Sim	Nome do ficheiro para o qual a obtenção tem de ser anulada.

Ação CopyDocument

Esta ação permite-lhe copiar um ficheiro de uma localização para outra.

Introduza os parâmetros da ação CopyDocument

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

Ação UploadDocument

Esta ação permite-lhe carregar um ficheiro.

Introduza os parâmetros da ação UploadDocument

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

Ação DownloadDocument

Esta ação permite-lhe transferir um ficheiro.

Introduza os parâmetros da ação DownloadDocument

Nome do parâmetro	Tipo de dados	Obrigatória	Descrição
RemoteFile	String	Sim	URL completo do ficheiro a transferir.
Biblioteca	String	Sim	Nome da biblioteca no servidor do SharePoint.
HasBytes	Booleano	Não	Especifica se o conteúdo deve ser transferido como bytes. O valor predefinido é false.

Ação MoveAttachmentOrDocument

Esta ação permite-lhe mover um ficheiro de uma pasta para outra.

Parâmetros de entrada da ação MoveAttachmentOrDocument

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

Ação CreateFolder

Esta ação permite-lhe criar uma pasta.

Parâmetros de entrada da ação CreateFolder

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

Ação AddAttachments

Esta ação permite-lhe adicionar um anexo.

Parâmetros de entrada da ação AddAttachments

Nome do parâmetro	Tipo de dados	Obrigatória	Descrição
ListTitle	String	Sim	Nome da lista de anexos.
FileName	String	Sim	Nome do ficheiro anexado.
ItemId	String	Sim	ID do anexo a adicionar.
Conteúdo	String	Sim	Conteúdo do anexo.
ContentBytes	String	Não	Conteúdo de bytes (como uma string Base64) a carregar como anexo. Use esta opção para carregar dados binários.
HasBytes	Booleano	Não	Especifica se o conteúdo a carregar é binário. O valor predefinido é false.

Ação DownloadAttachments

Esta ação permite-lhe transferir anexos.

Parâmetros de entrada da ação DownloadAttachments

Nome do parâmetro	Tipo de dados	Obrigatória	Descrição
RemoteFile	String	Sim	URL relativo do ficheiro.
HasBytes	Booleano	Não	Especifica se o conteúdo a transferir é binário. O valor predefinido é false.

Exemplos de ações

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

Exemplo: elimine um anexo

Este exemplo elimina o ficheiro especificado.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação DeleteAttachment e, de seguida, clique em Concluído.
3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:

   {
   "ListTitle": "My lists",
   "ItemId": "1",
   "FileName": "sitepages.txt"
   }

Se a ação for bem-sucedida, o parâmetro de resposta da tarefa terá um valor semelhante ao seguinte:DeleteAttachmentconnectorOutputPayload

[{
"Status": "Success"
}]

Exemplo: marcar num 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, de seguida, clique em Concluído.
3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:

   {
   "RelativeURL": "/Shared Documents/TestFolder",
   "DocumentName": "Document.txt",
   "Comment": "Comment test"
   }

Se a ação for bem-sucedida, o parâmetro de resposta da tarefa terá um valor semelhante ao seguinte:CheckInDocumentconnectorOutputPayload

[{
"Status": "Success"
}]

Exemplo: extraia um ficheiro

Este exemplo extrai um ficheiro.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação CheckOutDocument e, de seguida, clique em Concluído.
3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:

   {
   "RelativeURL": "/Shared Documents/TestFolder",
   "DocumentName": "Document.txt"
   }

Se a ação for bem-sucedida, o parâmetro de resposta da tarefa terá um valor semelhante ao seguinte:CheckOutDocumentconnectorOutputPayload

[{
"Status": "Success"
}]

Exemplo: rejeite uma saída

Este exemplo reverte a obtenção de um ficheiro.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação DiscardCheckOutDocument e, de seguida, clique em Concluído.
3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:

   {
   "RelativeURL": "/Shared Documents/TestFolder",
   "DocumentName": "Document.docx"
   }

Se a ação for bem-sucedida, o parâmetro de resposta da tarefa terá um valor semelhante ao seguinte:DiscardCheckOutDocumentconnectorOutputPayload

[{
"Status": "Success"
}]

Exemplo: copie um ficheiro

Este exemplo copia um ficheiro de uma localização para outra.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação CopyDocument e, de seguida, clique em Concluído.
3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:

   {
   "SourceFileRelativeUrl": "/Shared Documents/Document.docx",
   "DestFileRelativeUrl": "/Shared Documents/TestFolder/Document123.docx"
   }

Se a ação for bem-sucedida, o parâmetro de resposta da tarefa terá um valor semelhante ao seguinte:CopyDocumentconnectorOutputPayload

[{
"Status": "Success"
}]

Exemplo: carregue um ficheiro de texto

Este exemplo carrega um ficheiro de texto para a localização especificada.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação UploadDocument e, de seguida, clique em Concluído.
3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:

   {
   "FileName": "test.txt",
   "RelativeUrl": "/Shared Documents/TestFolder",
   "Content": "abcd"
   }

Se a ação for bem-sucedida, o parâmetro de resposta da tarefa terá um valor semelhante ao seguinte:UploadDocumentconnectorOutputPayload

[{
"Status": "Success"
}]

Exemplo: carregue um ficheiro binário

Este exemplo carrega um ficheiro binário para a localização especificada. Quando carregar um ficheiro binário, especifique o conteúdo a carregar 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, de seguida, clique em Concluído.
3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:

   {
   "FileName": "test.txt",
   "RelativeUrl": "/Shared Documents/TestFolder",
   "ContentBytes": "SGVsbG8gd29ybGQK",
   "HasBytes": "true"
   }

Se a ação for bem-sucedida, o parâmetro de resposta da tarefa terá um valor semelhante ao seguinte:UploadDocumentconnectorOutputPayload

[{
"Status": "Success"
}]

Exemplo: transferir um ficheiro

Este exemplo transfere um ficheiro.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação DownloadDocument e, de seguida, clique em Concluído.
3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:

   {
   "RemoteFile": "/TestFolder/test.txt",
   "Library": "Shared Documents"
   }

Se a ação for bem-sucedida, o parâmetro de resposta da tarefa terá um valor semelhante ao seguinte:DownloadDocumentconnectorOutputPayload

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

Exemplo: transferir um ficheiro binário

Este exemplo transfere um ficheiro binário.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação DownloadDocument e, de seguida, clique em Concluído.
3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:

   {
   "RemoteFile": "/TestFolder/test1.png",
   "Library": "Shared Documents"
   "HasBytes": "true"  
   }

Se a ação for bem-sucedida, o parâmetro de resposta da tarefa terá um valor semelhante ao seguinte:DownloadDocumentconnectorOutputPayload

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

Nota: o conteúdo transferido é uma string codificada em Base64.

Exemplo: transfira um ficheiro de um site específico

Este exemplo transfere um ficheiro de um site específico.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação DownloadDocument e, de seguida, clique em Concluído.
3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:

   {
     "RemoteFile": "	http://z8**.sharepoint.com/sites/SharepointGCS/Docs/SharpointGCS.docx",
     "Library": "Docs",
     "HasBytes": true
   }
   

Se a ação for bem-sucedida, o parâmetro de resposta DownloadDocumentconnectorOutputPayload da tarefa terá um valor semelhante ao seguinte:

[
  {
    "Success": "True",
    "ContentBytes": "UEsDBAoAAAAAAAAAIQD/////TwEAAE8BAAAQAAAAW3RyYXNoXS8wMDAwLmRhdP////nFmjQeC1QbGmk9o7n0xjiLgudAMOrYQBpOZdZp5/OrWkWbudVPccasL5uVSKun3URrHAxow7iMUm2WSi7nlGy2Mr+sjJxQSrYFcFtDQyo/QSutWhbNcAODEWh14mklzxCS9C5CW3Fmwme/gMKGjGoXlSVyvtDoB+u0A6XtA8bkWTnPNHSvxcepoAKIdsR96imCvxe4MxOWqHWnQkLDyjNMOMrrQeMDF7nOMCCvPlVn5Vd6KlDYnHlW1zLOcQf6WmKl2xN4Z8WBXZfkrJZqPv6yNdWyp8ADRmgTdRSqDkPpQqzvqWj3qpdiRZqSwyBRtfr2kHBumkTNjSi6drBMFMxZEgrktw6ZxuEXcx3v16cXd6k5JVO3kOXMg/HFnH"
  }
]

Para transferir um ficheiro de um site específico, tem de indicar o endereço completo do ficheiro remoto.

Exemplo: mova um anexo

Este exemplo move um anexo de uma localização para outra.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação MoveAttachmentOrDocument e, de seguida, clique em Concluído.
3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:

   {
   "SourceFileURL": "/Shared Documents/test.txt",
   "DestinationFolderURL": "/Shared Documents/TestFolder"
   }

Se a ação for bem-sucedida, o parâmetro de resposta da tarefa terá um valor semelhante ao seguinte:MoveAttachmentOrDocumentconnectorOutputPayload

[{
"Result": "Success"
}]

Exemplo: crie uma pasta

Este exemplo cria uma pasta na localização especificada.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação CreateFolder e, de seguida, clique em Concluído.
3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:

   {
   "RelativeURL": "/Shared Documents/TestFolder",
   "FolderName": "TestFolder123"
   }

Se a ação for bem-sucedida, o parâmetro de resposta da tarefa terá um valor semelhante ao seguinte:CreateFolderconnectorOutputPayload

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

Exemplo: adicione 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, de seguida, clique em Concluído.
3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:

   {
   "ListTitle": "My Lists",
   "FileName": "TestAttachment2",
   "Content": "abcd text",
   "ItemId": "1"
   }

Se a ação for bem-sucedida, o parâmetro de resposta da tarefa terá um valor semelhante ao seguinte:AddAttachmentsconnectorOutputPayload

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

Exemplo: adicione 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, de seguida, clique em Concluído.
3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:

   {
   "ListTitle": "My Lists",
   "FileName": "TestAttachment3",
   "ContentBytes": "VGVzdCBGaWxl",
   "HasBytes": "true",  
   "ItemId": "1"
   }

Se a ação for bem-sucedida, o parâmetro de resposta da tarefa terá um valor semelhante ao seguinte:AddAttachmentsconnectorOutputPayload

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

Exemplo: transferir um anexo

Este exemplo transfere um anexo.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação DownloadAttachments e, de seguida, clique em Concluído.
3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:

   {
   "RemoteFile": "/Shared Documents/Document.txt"
   }

Se a ação for bem-sucedida, o parâmetro de resposta da tarefa DownloadAttachmentsconnectorOutputPayload terá um valor semelhante ao seguinte:

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

Exemplo: transferir um anexo binário

Este exemplo transfere um anexo binário.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação DownloadAttachments e, de seguida, clique em Concluído.
3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:

   {
   "RemoteFile": "/Shared Documents/Document.docx",
   "HasBytes": "true"
   }

Se a ação for bem-sucedida, o parâmetro de resposta da tarefa DownloadAttachmentsconnectorOutputPayload terá um valor semelhante ao seguinte:

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

Nota: o conteúdo transferido é uma string codificada em Base64.

Exemplos de operações de entidades

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

Exemplo: listar todos os ficheiros

Este exemplo lista todos os ficheiros 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, de seguida, clique em Concluído.
4. Opcionalmente, na secção Entrada de tarefas da tarefa Conectores, pode filtrar o conjunto de resultados especificando uma cláusula de filtro. Também pode especificar várias condições de filtro através dos operadores lógicos.

Exemplo: obter uma lista

Este exemplo obtém 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, de seguida, clique em Concluído.
4. Na secção Entrada de tarefas da tarefa Conetores, clique em EntityId e, de seguida, introduza 3 no campo Valor predefinido.

   Aqui, 3 é um valor de chave principal na entidade My Lists.

Exemplo: crie um registo

Este exemplo cria um registo 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, de seguida, clique em Concluído.
4. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 tem um valor semelhante ao seguinte:

   [{
   "ID": 3.0
   }]

Exemplo: elimine um registo

Este exemplo elimina o registo 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, de seguida, clique em Concluído.
4. Na secção Entrada de tarefas da tarefa Conetores, clique em entityId e, de seguida, introduza 2 no campo Valor predefinido.

Nota: se a sua entidade tiver uma chave primária composta, pode especificar uma cláusula de filtro.

• Para compreender como criar e usar a tarefa Connectors no Apigee Integration, consulte o artigo Tarefa Connectors.
• Para compreender como criar e usar a tarefa Connectors na integração de aplicações, consulte o artigo Tarefa Connectors.

Obtenha ajuda da comunidade do Google Cloud

Pode publicar as suas perguntas e discutir este conector na comunidade do Google Cloud nos Fóruns do Cloud.

O que se segue?

• Compreenda como suspender e retomar uma associação.
• Compreenda como monitorizar a utilização do conector.
• Compreenda como ver os registos do conetor.