SharePoint

SharePoint 连接器可让 SQL 访问 SharePoint 服务和服务器。

支持的版本

此连接器支持 Windows SharePoint Services 3.0、Microsoft Office SharePoint Server 2007 及更高版本，以及 SharePoint Online。

准备工作

在使用 SharePoint 连接器之前，请先完成以下任务：

  • 在您的 Google Cloud 项目中：
    • 确保已设置网络连接。如需了解网络模式，请参阅网络连接。
    • 向配置连接器的用户授予 roles/connectors.admin IAM 角色。
    • 将以下 IAM 角色授予您要用其来使用连接器的服务账号：
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      服务账号是一种特殊类型的 Google 账号，用于表示需要验证身份并获得授权以访问 Google API 数据的非人类用户。如果您没有服务账号，则必须创建一个服务账号。如需了解详情，请参阅创建服务账号。

    • 启用以下服务：
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

      如需了解如何启用服务，请参阅启用服务。

    如果之前没有为您的项目启用这些服务或权限，则在您配置连接器时，系统会提示您启用。

配置连接器

配置连接器时，您需要创建与数据源（即后端系统）的连接。一个连接需专用于一个数据源。这意味着，如果您有许多数据源，则必须为每个数据源创建单独的连接。如需创建连接，请执行以下步骤：

  1. 在 Cloud 控制台 中，进入 Integration Connectors > 连接页面，然后选择或创建一个 Google Cloud 项目。

    转到“连接”页面

  2. 点击 + 新建以打开创建连接页面。
  3. 在位置部分中，选择连接的位置。
    1. 区域：从下拉列表中选择一个位置。

      连接器支持的区域包括：

      如需查看所有受支持区域的列表，请参阅位置。

    2. 点击下一步。
  4. 在连接详情部分中，完成以下操作：
    1. 连接器：从可用连接器的下拉列表中选择 SharePoint。
    2. 连接器版本：从可用版本的下拉列表中选择一个连接器版本。
    3. 在连接名称字段中，输入连接实例的名称。

      连接名称必须符合以下条件：

      • 连接名称可以使用字母、数字或连字符。
      • 字母必须小写。
      • 连接名称必须以字母开头，以字母或数字结尾。
      • 连接名称不能超过 49 个字符。
    4. （可选）输入连接实例的说明。
    5. 您可以选择启用 Cloud Logging，然后选择日志级别。默认情况下，日志级别设置为 Error。
    6. 服务账号：选择具有所需角色的服务账号。
    7. （可选）配置连接节点设置：

      • 节点数下限：输入连接节点数下限。
      • 节点数上限：输入连接节点数上限。

      节点是处理事务的连接单元（或副本）。 连接处理越多事务就需要越多节点，相反，处理越少事务需要越少节点。 如需了解节点如何影响连接器价格，请参阅连接节点的价格。如果未输入任何值，则默认情况下，节点数下限设置为 2（以便提高可用性），节点数上限设置为 50。

    8. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
    9. 点击下一步。
  5. 在目标部分中，输入要连接到的远程主机（后端系统）的详细信息。
    1. 目标类型：选择目标类型。例如，主机地址为 https://xxxxx.sharepoint.com。
      • 从列表中选择主机地址，以指定目标的主机名或 IP 地址。
      • 如果要与后端系统建立专用连接，请从列表中选择端点连接，然后从端点连接列表中选择所需的端点连接。

      如果要与后端系统建立公共连接以提高安全性，您可以考虑为连接配置静态出站 IP 地址，然后将防火墙规则配置为仅将特定静态 IP 地址列入许可名单。

      如需输入其他目标，请点击 + 添加目标。

    2. 点击下一步。
  6. 在身份验证部分中，输入身份验证详细信息。
    1. 选择身份验证类型，然后输入相关详细信息。

      SharePoint 连接支持以下身份验证类型：

      • Windows 凭据。如果您使用的是 SharePoint 的本地版本，请选择此选项。
      • AzureAD。如果您使用的是 SharePoint 的在线版，请选择此选项。
      • 包含 JWT 不记名令牌的 OAuth 2.0 客户端凭据。如果您将 OAuth 2.0 客户端凭据与 JWT 不记名令牌搭配使用进行身份验证，请选择此选项。
      • 包含客户端密钥的 OAuth 2.0 客户端凭据。如果您使用 OAuth 2.0 客户端凭据和客户端 Secret 进行身份验证，请选择此选项。

      2. 如需了解如何配置这些身份验证类型，请参阅配置身份验证。

    2. 点击下一步。
  7. 查看：查看您的连接和身份验证详细信息。
  8. 点击创建。

配置身份验证

SharePoint 连接器支持以下身份验证类型：

Windows 凭据身份验证类型

如需启用 Windows 凭据身份验证类型，您必须完成以下步骤：
  1. 配置 PSC 并创建端点连接。
  2. 在 Google Cloud中指定凭据。

配置 PSC 并创建端点连接

  1. 使用托管 SharePoint 的 IP 地址创建实例组。
  2. 创建内部直通式网络负载平衡器，并将您创建的实例组用作后端。TCP 内部负载平衡器必须启用全球访问权限。
  3. 在 Private Service Connect 中发布负载平衡器。负载平衡器发布后，系统会生成服务连接。
  4. 发布服务并指定您创建的负载平衡器。
  5. 使用服务连接创建端点连接。
  6. 创建端点连接后，使用端点连接 IP 创建 SharePoint 连接。

    7. 如需详细了解如何创建端点附件，请参阅创建端点附件。

在 Google Cloud中指定 Windows 凭据详情

在集成连接器中创建连接时，您必须指定以下详细信息：

在身份验证部分中，选择 Windows 凭据作为身份验证类型，然后输入以下详细信息：

  • 用户名：输入用户名。
  • 密码：选择密码。
  • Secret 版本：输入 Secret 版本。

Windows 凭据连接类型

下表列出了 Windows 凭据连接类型的示例配置值。
字段名称 详情
区域 us-central1
连接器 SharePoint
连接器版本 1
连接名称 sharepoint-staging-psc
服务账号 SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
节点数下限 2
节点数上限 50
目标类型 主机地址
主机 1 http://192.0.2.0
端口 1 24
Authentication Windows 凭据
用户名 USER_NAME
密码 密码
密钥版本 1

Azure AD 身份验证类型

如需启用 Azure AD 身份验证类型，您必须完成以下步骤：
  1. 注册您的应用并获取 OAuthClientId 和 OAuthClientSecret。
  2. 在 Google Cloud中指定凭据。
  3. 在 Google Cloud中授权关联。
  4. 将重定向网址添加到您的应用。

注册您的应用并获取 OAuthClientId 和 OAuthClientSecret

如需注册您的应用并获取应用的 OAuthClientId 和 OAuthClientSecret，请执行以下操作：
  1. 登录 Azure 门户。
  2. 在 Azure 服务中，依次选择应用注册和新注册。
  3. 输入应用名称，然后选择 Any Microsoft Entra ID tenant - Multitenant（任意 Microsoft Entra ID 租户 - 多租户）。下图显示了“注册应用”页面：
  4. 创建应用后，前往证书和密钥部分，为应用创建客户端密钥，然后保存客户端密钥值。下图显示了证书和密钥页面：
  5. 在 API 权限中，选择所需的应用权限和委托权限。为了让连接保持有效，您必须至少授予以下权限：AllSites.Manage

    下表列出了在应用中执行操作所需的权限。

    委托的权限 应用权限
    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. 保存更改。
  7. 如果您选择使用需要管理员同意的权限，则可以在当前租户的 API 权限页面上授予这些权限。下图显示了 API 权限页面：
  8. 如需添加此范围，请前往公开 API 部分，添加 AllSites.Manage, Sites.FullControl.All 范围，然后选择可以进行控制的人员（管理员和用户）。下图显示了“公开 API”页面：
  9. 点击保存。

在 Google Cloud中指定凭据

在集成连接器中创建连接时，您必须指定以下详细信息：

在身份验证部分中，选择 AzureAD 作为身份验证类型，然后输入以下详细信息：

  • 客户端 ID：输入用于请求访问令牌的客户端 ID。
  • 范围：输入所需范围的逗号分隔列表。例如 Sites.FullControl.All
  • 客户端密钥：输入包含您创建的关联应用的客户端密钥的 Secret。
  • Secret 版本：上方所选 Secret 的 Secret 版本。
  • 授权网址：创建客户端时生成的授权网址。请按照以下格式输入网址：https://login.microsoftonline.com/<tenant_identifier>/oauth2/v2.0/authorize。例如 https://login.microsoftonline.com/9bxxxxxxxxx8112/oauth2/v2.0/authorize。

在 Google Cloud中授权关联

  1. 在“连接”页面中，找到新创建的连接。

    新连接器的状态将为需要授权。

  2. 点击需要授权。

    系统随即会显示修改授权窗格。

  3. 将重定向 URI 值复制到您的外部应用。如需了解详情，请参阅向应用添加重定向网址。
  4. 验证授权详细信息。
  5. 点击授权。

    如果授权成功，“连接”页面中的连接状态将设为有效。

将重定向网址添加到您的应用

  1. 在 Azure 门户中，依次点击 Azure 服务 > 应用注册。
  2. 点击您的应用名称。
  3. 点击“添加重定向 URI”。
  4. 点击添加平台。
  5. 在 Web 对话框中，粘贴您在 Google Cloud中授权连接时复制的重定向 URI。

Azure AD 连接类型

下表列出了 Azure AD 连接类型的示例配置值：
字段名称 详细信息
区域 us-central1
连接器 SharePoint
连接器版本 1
连接名称 sharepoint-google-cloud-con
服务账号 SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
节点数下限 2
节点数上限 50
目标类型 主机地址
主机 1 http://z8**.sharepoint.com
身份验证 AzureAD
客户端 ID CLIENT_ID
范围 Sites.FullControl.All
客户端密钥 CLIENT_SECRET
密钥版本 1
授权网址 https://login.microsoftonline.com/{tenant-id}/oauth2/v2.0/authorize

OAuth 2.0 - 客户端凭据（使用 JWT 不记名令牌身份验证类型）

如需启用 OAuth 2.0 - 客户端凭据（使用 JWT 不记名令牌）身份验证类型，您必须完成以下步骤：
  1. 创建证书。
  2. 将证书上传到 Azure 门户。
  3. 获取私钥。
  4. 完成设置。
  5. 在 Google Cloud中指定 OAuth 2.0 JWT 不记名凭据。

如需启用 JWT 令牌持有人身份验证类型，您需要创建证书，将其上传到 Azure 门户，然后获取私钥。

创建证书

  1. 在计算机上创建一个空文件夹。
  2. 在该文件夹中创建一个文本文件。
  3. 从 “通过 Azure AD 仅限应用授予访问权限”页面 复制 PowerShell 脚本，然后将其粘贴到文本文件中。
  4. 将文本文件重命名为以下名称：Create-SelfSignedCertificate.ps1。
  5. 在该文件夹中运行 Windows PowerShell。
  6. 前往包含文本文件的目录。
  7. 复制以下命令： .\Create-SelfSignedCertificate.ps1 -CommonName "CERTIFICATE_NAME" -StartDate 2022-09-25 -EndDate 2023-10-25

    为 CERTIFICATE_NAME 输入一个具有唯一性的名称。将 StartDate 更改为当前日期，将 EndDate 更改为您选择的日期。

  8. 将复制的命令（包括所做的更改）粘贴到 Windows PowerShell 中，然后按 Enter 键。

    Windows PowerShell 会提示您输入密码以保护私钥。请务必保存密码以供日后使用。

    Windows PowerShell 会创建两个文件：MyCertificate.pfx 和 MyCertificate.cer。

将证书上传到 Azure 门户

  1. 登录 Azure 门户，然后指定以下详细信息以注册新应用：
    • 名称：输入应用的名称。
    • 支持的账号类型：选择仅此组织目录中的账号（仅账号名称 - 单租户）。
  2. 依次前往 API 权限 > 添加权限 > 请求 API 权限 > SharePoint。
  3. 选择应用权限，然后添加所需权限。
  4. 选择授予管理员同意，然后选择是。
  5. 创建应用后，前往证书和 Secret 部分。
  6. 选择 Upload Certificate（上传证书），然后从计算机上传 CER 证书。上传完成后，选择添加。

    请勿在应用中添加客户端密钥，因为这会干扰基于证书的身份验证流程。

  7. 前往“清单”，找到“KeyCredentials”，然后将 customKeyIdentifier 复制为“Thumbprint”。您稍后会用到这个值。您现在已注册应用并关联证书。

获取私钥

您可以使用 OpenSSL 将 PFX 文件转换为 PEM 文件，从而获取私钥。

  1. 在命令提示符中，前往包含 PFX 文件的文件夹，然后运行以下命令： openssl pkcs12 -in MyCertificate.pfx -out MyCertificate.pem -nodes
  2. 输入您在证书创建过程中使用的 PFX 密码。
  3. 在文本编辑器中打开 PEM 文件，然后复制私钥的以下部分： 
    -----BEGIN PRIVATE KEY----- 

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

完成设置

  1. 从 Azure 门户中新注册的应用复制客户端 ID 和租户 ID。
  2. 使用以下凭据通过 SharePoint 列表服务主账号身份验证登录：
    • 客户端 ID
    • 租户 ID
    • 私钥
    • 指纹（私钥密码）

在 Google Cloud中指定 OAuth 2.0 JWT 不记名凭据

在集成连接器中创建连接时，您必须指定以下详细信息：

在身份验证部分中，选择 OAuth 2.0 客户端凭据（包含 JWT 不记名令牌）作为身份验证类型，然后输入以下详细信息：

  • 客户端 ID：输入用于请求访问令牌的客户端 ID。这是您在 Azure 门户中注册应用时生成的使用方密钥。
  • 私钥：选择包含 PEM 格式的私钥文件内容的 Secret Manager 密钥。私钥应与提供给连接器的公钥/证书匹配。
  • Secret 版本：上方所选 Secret 的 Secret 版本。
  • 私钥密码：选择包含私钥文件的密码（短语）的 Secret Manager 密文。
  • Secret 版本：上方所选 Secret 的 Secret 版本。
  • Azure 租户：用于访问数据的 Microsoft 在线租户。

JWT 不记名证书连接类型

下表列出了 OAuth 2.0 JWT 不记名证书连接类型的示例配置值。
字段名称 详情
区域 europe-west1
连接器 SharePoint
连接器版本 1
连接名称 sharepoint-jwt-certificate
服务账号 SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
节点数下限 2
节点数上限 50
目标类型 主机地址
主机 1 http://z8**.sharepoint.com
端口 1 ****
Authentication 包含 JWT 不记名令牌的 OAuth 2.0 客户端凭据
OAuth 客户端 ID CLIENT_ID
私钥 图例
密钥版本 1
私钥密码 密码
密钥版本 1
Azure 租户 AZURE_TENANT_ID

OAuth 2.0 - 客户端密钥连接类型

如需启用 OAuth 2.0 客户端密钥连接类型，您必须完成以下步骤：

  1. 注册插件。
  2. 向该插件授予权限。
  3. 在 Google Cloud中指定 OAuth 2.0 客户端凭据
  4. 重新授权授权代码

注册插件

  1. 使用以下网址： https://<SITE_NAME>.SharePoint.com/_layouts/15/appregnew.aspx 前往注册插件页面。
  2. 在应用信息部分，生成客户端 ID 和客户端密钥。
  3. 为“标题”“应用网域”和“重定向 URI”指定值。
  4. 点击创建。该插件随即注册，SharePoint 应用会显示所创建的信息。

向该插件授予权限

  1. 使用以下网址前往 SharePoint 网站：https://<SITE_NAME>-admin.sharepoint.com/_layouts/15/appinv.aspx。系统会将您重定向到授予权限页面。
  2. 在 App Id（应用 ID）字段中，输入您之前生成的客户端 ID，然后点击 Lookup（查询）。系统会填充“标题”“应用网域”和“重定向网址”的值。
  3. 以 XML 格式输入以下权限请求： 
    <AppPermissionRequests AllowAppOnlyPolicy="true">
<AppPermissionRequest Scope="http://sharepoint/content/tenant" Right="FullControl"/>
</AppPermissionRequests>
  4. 点击“创建”。SharePoint 应用会显示权限意见征求对话框。
  5. 点击信任。

在 Google Cloud中指定 OAuth 2.0 客户端凭据

在集成连接器中创建连接时，您必须指定以下详细信息：

在身份验证部分中，选择 OAuth 2.0 客户端凭据（含客户端密钥）作为身份验证类型，然后输入以下详细信息：

  • 客户端 ID：输入连接器为您创建的应用提供的客户端 ID。
  • 客户端密钥：选择包含您创建的关联应用的客户端密钥的 Secret Manager 密钥。
  • Secret 版本：选择客户端密钥的版本。

重新授权授权代码

如果您使用的是 Authorization code 身份验证类型，并且在 SharePoint 应用中进行了任何配置更改，则必须重新授权 SharePoint 连接。如需重新授权关联，请执行以下步骤：

  1. 在“连接”页面中，点击所需的连接。

    系统随即会打开连接详情页面。

  2. 点击修改以修改关联详情。
  3. 在身份验证部分中，验证 OAuth 2.0 - 授权代码详细信息。

    根据需要进行必要的更改。

  4. 点击保存。您随即会进入连接详情页面。
  5. 点击身份验证部分中的修改授权。系统随即会显示 Authorize（授权）窗格。
  6. 点击授权。

    如果授权成功，“连接”页面中的连接状态将设为有效。

客户端凭据连接类型

下表列出了 OAuth 2.0 客户端凭据连接类型的示例配置值。
字段名称 详细信息
区域 europe-west1
连接器 SharePoint
连接器版本 1
连接名称 sharepoint-client-credentials
服务账号 SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
节点数下限 2
节点数上限 50
目标类型 主机地址
主机 1 http://z8**.sharepoint.com
端口 1 ****
身份验证 包含客户端密钥的 OAuth 2.0 客户端凭据
客户端 ID CLIENT_ID
客户端密钥 CLIENT_SECRET
密钥版本 1

实体、操作和动作

所有集成连接器都会为所连接应用的对象提供抽象层。您只能通过此抽象访问应用的对象。抽象作为实体、操作和动作向您展示。

  • 实体：实体可以被视为连接的应用或服务中的对象或属性集合。不同连接器的实体定义也会有所不同。例如，在数据库连接器中，表是实体；在文件服务器连接器中，文件夹是实体；在消息传递系统连接器中，队列是实体。

    但可能的情况是，连接器不支持或不具有任何实体，在这种情况下，Entities 列表将为空。

  • 操作：操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作：

    从可用列表中选择一个实体，系统会生成该实体可用的操作列表。如需了解操作的详细说明，请参阅连接器任务的实体操作。不过，如果连接器不支持任何实体操作，则 Operations 列表中不会列出此类不受支持的操作。

  • 动作：动作是可通过连接器接口提供给集成的头等函数。动作可让您对一个或多个实体进行更改，并且动作因连接器而异。通常，操作会有一些输入参数和一个输出参数。但可能的情况是，连接器不支持任何动作，在这种情况下，Actions 列表将为空。

操作

本部分列出了该连接器支持的一些操作。如需了解如何配置操作，请参阅操作示例。

DeleteAttachment 操作

此操作会删除附件。

DeleteAttachment 操作的输入参数

参数名称 数据类型 必需 说明
ListTitle 字符串 是 列表项的标题。
ItemId 字符串 是 列表项的 ID。
文件名 字符串 是 要从文档库中删除的文件的名称。

如需了解如何配置 DeleteAttachment 操作，请参阅操作示例。

CheckInDocument 操作

您可以通过此操作签入文档。

CheckInDocument 操作的输入参数

参数名称 数据类型 必需 说明
Relative网址 字符串 是 文件夹的相对网址。
DocumentName 字符串 是 要签入的文件的名称。
评论 字符串 否 消息中的可选复选框。

如需了解如何配置 CheckInDocument 操作，请参阅操作示例。

CheckOutDocument 操作

您可以通过此操作检出文件。

CheckOutDocument 操作的输入参数

参数名称 数据类型 必需 说明
Relative网址 字符串 是 文件夹的相对网址。
DocumentName 字符串 是 要签出的文件的名称。

如需了解如何配置 CheckOutDocument 操作，请参阅操作示例。

DiscardCheckOutDocument 操作

您可以通过此操作撤消文件签出。

DiscardCheckOutDocument 操作的输入参数

参数名称 数据类型 必需 说明
Relative网址 字符串 是 文件夹的相对网址。
DocumentName 字符串 是 必须撤消检出的文件的名称。

如需了解如何配置 DiscardCheckOutDocument 操作，请参阅操作示例。

CopyDocument 操作

借助此操作，您可以将文件从一个位置复制到另一个位置。

CopyDocument 操作的输入参数

参数名称 数据类型 必需 说明
SourceFileRelativeUrl 字符串 是 源文件的相对网址。
DestFileRelativeUrl 字符串 是 目标文件的相对网址。

如需了解如何配置 CopyDocument 操作，请参阅操作示例。

UploadDocument 操作

通过此操作，您可以上传文件。

UploadDocument 操作的输入参数

参数名称 数据类型 必需 说明
文件名 字符串 是 要上传的文件的名称。
RelativeUrl 字符串 是 文件夹的相对网址。
内容 字符串 否 要作为文件上传的内容。
ContentBytes 字符串 否 要作为文件上传的字节内容（以 Base64 字符串表示）。使用此方法上传二进制数据。
HasBytes 布尔值 否 指定要上传的内容是否为二进制内容。默认值为 false。

如需了解如何配置 UploadDocument 操作，请参阅操作示例。

DownloadDocument 操作

通过此操作，您可以下载文件。

DownloadDocument 操作的输入参数

参数名称 数据类型 必需 说明
RemoteFile 字符串 是 要下载的文件的完整网址。
库 字符串 是 SharePoint 服务器上库的名称。
HasBytes 布尔值 否 指定内容是否应以字节形式下载。默认值为 false。

如需了解如何配置 DownloadDocument 操作，请参阅操作示例。

MoveAttachmentOrDocument 操作

通过此操作，您可以将文件从一个文件夹移至另一个文件夹。

MoveAttachmentOrDocument 操作的输入参数

参数名称 数据类型 必需 说明
SourceFile网址 字符串 是 应移动的源文件的网址。
DestinationFolder网址 字符串 是 目标文件夹的网址。

如需了解如何配置 MoveAttachmentOrDocument 操作，请参阅操作示例。

CreateFolder 操作

通过此操作，您可以创建文件夹。

CreateFolder 操作的输入参数

参数名称 数据类型 必需 说明
Relative网址 字符串 是 文件夹的相对网址。
FolderName 字符串 是 要创建的文件夹的名称。

如需了解如何配置 CreateFolder 操作，请参阅操作示例。

AddAttachments 操作

通过此操作，您可以添加附件。

AddAttachments 操作的输入参数

参数名称 数据类型 必需 说明
ListTitle 字符串 是 附件列表的名称。
文件名 字符串 是 附件文件的名称。
ItemId 字符串 是 要添加的附件的 ID。
内容 字符串 是 附件的具体内容。
ContentBytes 字符串 否 要作为附件上传的字节内容（以 Base64 字符串的形式）。使用此方法上传二进制数据。
HasBytes 布尔值 否 指定要上传的内容是否为二进制内容。默认值为 false。

如需了解如何配置 AddAttachments 操作，请参阅操作示例。

DownloadAttachments 操作

通过此操作，您可以下载附件。

DownloadAttachments 操作的输入参数

参数名称 数据类型 必需 说明
RemoteFile 字符串 是 文件的相对网址。
HasBytes 布尔值 否 指定要下载的内容是否为二进制内容。默认值为 false。

如需了解如何配置 DownloadAttachments 操作，请参阅操作示例。

操作示例

本部分介绍如何在此连接器中执行一些操作。

示例 - 删除附件

此示例会删除指定的文件。

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 DeleteAttachment 操作，然后点击完成。
  3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值： 
    {
"ListTitle": "My lists",
"ItemId": "1",
"FileName": "sitepages.txt"
}

    4. 如果操作成功，DeleteAttachment 任务的 connectorOutputPayload 响应参数的值将类似于以下内容：

    [{
"Status": "Success"
}]

示例 - 签入文档

以下示例会提交文档。

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 CheckInDocument 操作，然后点击完成。
  3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值： 
    {
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.txt",
"Comment": "Comment test"
}

    4. 如果操作成功，CheckInDocument 任务的 connectorOutputPayload 响应参数的值将类似于以下内容：

    [{
"Status": "Success"
}]

示例 - 检出文件

以下示例会检出文件。

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 CheckOutDocument 操作，然后点击完成。
  3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值： 
    {
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.txt"
}

    4. 如果操作成功，CheckOutDocument 任务的 connectorOutputPayload 响应参数的值将类似于以下内容：

    [{
"Status": "Success"
}]

示例 - 舍弃签出

此示例会还原文件签出。

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 DiscardCheckOutDocument 操作，然后点击完成。
  3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值： 
    {
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.docx"
}

    4. 如果操作成功，DiscardCheckOutDocument 任务的 connectorOutputPayload 响应参数的值将类似于以下内容：

    [{
"Status": "Success"
}]

示例 - 复制文件

此示例会将文件从一个位置复制到另一个位置。

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 CopyDocument 操作，然后点击完成。
  3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值： 
    {
"SourceFileRelativeUrl": "/Shared Documents/Document.docx",
"DestFileRelativeUrl": "/Shared Documents/TestFolder/Document123.docx"
}

    4. 如果操作成功，CopyDocument 任务的 connectorOutputPayload 响应参数的值将类似于以下内容：

    [{
"Status": "Success"
}]

示例 - 上传文本文件

此示例将文本文件上传到指定位置。

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 UploadDocument 操作，然后点击完成。
  3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值： 
    {
"FileName": "test.txt",
"RelativeUrl": "/Shared Documents/TestFolder",
"Content": "abcd"
}

    4. 如果操作成功，UploadDocument 任务的 connectorOutputPayload 响应参数的值将类似于以下内容：

    [{
"Status": "Success"
}]

示例 - 上传二进制文件

此示例会将二进制文件上传到指定位置。上传二进制文件时，请将要上传的内容指定为 Base64 编码的字符串。

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 UploadDocument 操作，然后点击完成。
  3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值： 
    {
"FileName": "test.txt",
"RelativeUrl": "/Shared Documents/TestFolder",
"ContentBytes": "SGVsbG8gd29ybGQK",
"HasBytes": "true"
}

    4. 如果操作成功，UploadDocument 任务的 connectorOutputPayload 响应参数的值将类似于以下内容：

    [{
"Status": "Success"
}]

示例 - 下载文件

此示例会下载文件。

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 DownloadDocument 操作，然后点击完成。
  3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值： 
    {
"RemoteFile": "/TestFolder/test.txt",
"Library": "Shared Documents"
}

    4. 如果操作成功，DownloadDocument 任务的 connectorOutputPayload 响应参数的值将类似于以下内容：

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

示例 - 下载二进制文件

此示例会下载二进制文件。

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 DownloadDocument 操作，然后点击完成。
  3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值： 
    {
"RemoteFile": "/TestFolder/test1.png",
"Library": "Shared Documents"
"HasBytes": "true"  
}

    4. 如果操作成功，DownloadDocument 任务的 connectorOutputPayload 响应参数的值将类似于以下内容：

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

示例 - 移动附件

此示例将附件从一个位置移至另一个位置。

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 MoveAttachmentOrDocument 操作，然后点击完成。
  3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值： 
    {
"SourceFileURL": "/Shared Documents/test.txt",
"DestinationFolderURL": "/Shared Documents/TestFolder"
}

    4. 如果操作成功，MoveAttachmentOrDocument 任务的 connectorOutputPayload 响应参数的值将类似于以下内容：

    [{
"Result": "Success"
}]

示例 - 创建文件夹

此示例会在指定位置创建一个文件夹。

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 CreateFolder 操作，然后点击完成。
  3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值： 
    {
"RelativeURL": "/Shared Documents/TestFolder",
"FolderName": "TestFolder123"
}

    4. 如果操作成功，CreateFolder 任务的 connectorOutputPayload 响应参数的值将类似于以下内容：

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

示例 - 添加附件

此示例将附件添加到指定列表。

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 AddAttachments 操作，然后点击完成。
  3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值： 
    {
"ListTitle": "My Lists",
"FileName": "TestAttachment2",
"Content": "abcd text",
"ItemId": "1"
}

    4. 如果操作成功，AddAttachments 任务的 connectorOutputPayload 响应参数的值将类似于以下内容：

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

示例 - 添加二进制附件

此示例将二进制附件添加到指定列表。

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 AddAttachments 操作，然后点击完成。
  3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值： 
    {
"ListTitle": "My Lists",
"FileName": "TestAttachment3",
"ContentBytes": "VGVzdCBGaWxl",
"HasBytes": "true",  
"ItemId": "1"
}

    4. 如果操作成功，AddAttachments 任务的 connectorOutputPayload 响应参数的值将类似于以下内容：

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

示例 - 下载附件

此示例下载了附件。

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 DownloadAttachments 操作，然后点击完成。
  3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值： 
    {
"RemoteFile": "/Shared Documents/Document.txt"
}

    4. 如果操作成功，DownloadAttachments 任务的 connectorOutputPayload 响应参数的值将类似于以下内容：

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

示例 - 下载二进制附件

此示例会下载二进制附件。

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 DownloadAttachments 操作，然后点击完成。
  3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值： 
    {
"RemoteFile": "/Shared Documents/Document.docx",
"HasBytes": "true"
}

    4. 如果操作成功，DownloadAttachments 任务的 connectorOutputPayload 响应参数的值将类似于以下内容：

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

实体操作示例

本部分介绍如何在此连接器中执行一些实体操作。

示例 - 列出所有文件

此示例列出了 Files 实体中的所有文件。

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 Files。
  3. 选择 List 操作，然后点击完成。
  4. 您还可以在连接器任务的任务输入部分中，通过指定过滤条件子句来过滤结果集。您还可以使用逻辑运算符指定多个过滤条件。

示例 - 获取列表

以下示例会从 My Lists 实体中获取具有指定 ID 的列表。

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 My Lists。
  3. 选择 Get 操作，然后点击完成。
  4. 在连接器任务的任务输入部分，点击 EntityId，然后在默认值字段中输入 3。

    其中，3 是 My Lists 实体中的主键值。

示例 - 创建记录

此示例在 My Lists 实体中创建一条记录。

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 My Lists。
  3. 选择 Create 操作，然后点击完成。
  4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值： 
    {
"AuthorId": 11.0, 
"BaseName": "3_",
"Attachments": false,
"Title": "Created List New"
}

    如果集成成功，连接器任务的 connectorOutputPayload 字段的值将类似于以下内容：

    [{
"ID": 3.0
}]

示例 - 删除记录

以下示例会删除 My Lists 实体中具有指定 ID 的记录。

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 My Lists。
  3. 选择 Delete 操作，然后点击完成。
  4. 在连接器任务的任务输入部分，点击 entityId，然后在默认值字段中输入 2。

在集成中使用 SharePoint 连接

创建连接后，该连接将在 Apigee Integration 和 Application Integration 中可用。您可以通过连接器任务在集成中使用该连接。

  • 如需了解如何在 Apigee Integration 中创建和使用连接器任务，请参阅连接器任务。
  • 如需了解如何在 Application Integration 中创建和使用连接器任务，请参阅连接器任务。

向 Google Cloud 社区寻求帮助

您可以在 Google Cloud 社区的 Cloud 论坛中发布您的问题以及讨论此连接器。

后续步骤