Microsoft Teams

Microsoft Teams 连接器提供与 Microsoft Teams 应用的连接。

准备工作

在使用 Microsoft Teams 连接器之前,请先完成以下任务:

  • 在您的 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. 连接器:从可用连接器的下拉列表中选择 Microsoft Teams。
    2. 连接器版本:从可用版本的下拉列表中选择一个连接器版本。
    3. 在连接名称字段中,输入连接实例的名称。

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

      • 连接名称可以使用字母、数字或连字符。
      • 字母必须小写。
      • 连接名称必须以字母开头,以字母或数字结尾。
      • 连接名称不能超过 63 个字符。
    4. (可选)输入连接实例的说明。
    5. 服务账号:选择具有所需角色的服务账号。
    6. 输入连接实例的 Azure 租户。
    7. (可选)选择包含所有群组,以包含组织中的所有群组
    8. (可选)配置连接节点设置:

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

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

    9. SSL 配置:从信任模型中选择公开(默认)。
    10. 点击下一步。
    11. 在身份验证部分中,完成以下操作:
      1. 客户端 ID:请求访问令牌时所用的客户端 ID。
      2. 范围:以英文逗号分隔的所需范围列表
      3. 客户端密钥:包含您创建的关联应用的客户端密钥的 Secret Manager 密文。
      4. 密钥版本:包含客户端密钥的密钥的版本。
      5. 授权网址:创建 OAuth 客户端时生成的授权网址。 以以下格式输入网址:https://login.microsoftonline.com/TENANT_IDENTIFIER/oauth2/v2.0/authorize?prompt=consent。 例如 https://login.microsoftonline.com/9bxxxxxxxxx8112/oauth2/v2.0/authorize?prompt=consent。
      6. 点击下一步。
    12. 查看:查看您的连接和身份验证详细信息。
    13. 点击创建。

    对于 Authorization code 身份验证类型,创建连接后,您必须执行一些额外的步骤来配置身份验证。如需了解详情,请参阅创建连接后的其他步骤。

    创建连接后的其他步骤

    如果您为身份验证选择了 OAuth 2.0 - Authorization code,则必须在创建连接后执行以下额外步骤:

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

      请注意,新连接器的状态将为需要授权。

    2. 点击需要授权。

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

    3. 将重定向 URI 值复制到外部应用。
    4. 验证授权详细信息。
    5. 点击授权。

      如果授权成功,系统会在“连接”页面中将连接状态设置为有效。

    授权代码的重新授权

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

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

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

    2. 点击修改即可修改连接详情。
    3. 在身份验证部分中,验证 OAuth 2.0 - 授权代码详细信息。

      如有需要,请进行必要的更改。

    4. 点击保存。系统随即会转到连接详情页面。
    5. 在身份验证部分中,点击修改授权。系统会显示授权窗格。
    6. 点击授权。

      如果授权成功,系统会在“连接”页面中将连接状态设置为有效。

    系统限制

    对于 Team Members, Times Off, Channels, and Chats 实体的列表操作,Microsoft Teams 连接器每个分钟、每个节点可处理 30 个事务,超出此限制的任何事务都会受到限制。

    默认情况下,Integration Connectors 会为连接分配 2 个节点(以提高可用性)。

    如需了解适用于 Integration Connectors 的限制,请参阅限制。

    实体、操作和动作

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

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

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

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

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

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

    操作示例

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

    示例 - 操作

    此示例向特定 Chat 实体发送消息。

    1. 在 Configure connector task 对话框中,点击 Actions。
    2. 从 Actions 列表中选择 SendMessage。
    3. 选择 Actions 操作,然后点击完成。
    4. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
            {
              "TeamId": "cc110f3f-3088-4b4c-b965-e1f3e0a2dfab",
              "ChannelId": "19%3a7680178ef3ab4b1eb762a7078b990083%40thread.tacv2",
              "Content": "Hello Guys Lets play"
            }

    实体操作示例

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

    示例 - 列出所有记录

    此示例列出了 Channel Members 实体中的所有记录。

    1. 在 Configure connector task 对话框中,点击 Entities。
    2. 从 Entity 列表中选择 Channel Members。
    3. 选择 List 操作,然后点击完成。
    4. 或者,您可以在连接器任务的任务输入部分中,通过指定过滤条件子句来过滤结果集。请始终使用英文单引号 (') 括起过滤条件子句值。例如,Id='13b1724a91ce448bad2f1986321fc70f'。您还可以使用逻辑运算符指定多个过滤条件。例如 Id='13b1724a91ce448bad2f1986321fc70f' and Inactive=false。

    示例 - 获取记录

    此示例从 Chats 实体获取具有指定 ID 的记录。

    1. 在 Configure connector task 对话框中,点击 Entities。
    2. 从 Entity 列表中选择 Chats。
    3. 选择 Get 操作,然后点击完成。
    4. 在连接器任务的任务输入部分,点击 EntityId,然后在默认值字段中输入 19:1956432abc05491bb26f51f9f7263020@thread.v2。

      在此示例中,19:1956432abc05491bb26f51f9f7263020@thread.v2 是 Chats 实体的某个主键值。

    示例 - 创建记录

    此示例在 Group Owners 实体中创建一条记录。

    1. 在 Configure connector task 对话框中,点击 Entities。
    2. 从 Entity 列表中选择 Group Owners。
    3. 选择 Create 操作,然后点击完成。
    4. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
      {
        "GroupId": "1356c566-d799-4d49-86c0-b09ab6afdb47",
        "MemberId": "caf19b29-3af1-4191-b455-16468e6aba4b"
      }

      如果集成成功,连接器任务的 connectorOutputPayload 字段将具有类似以下的值:

      {
      "Id": "c3c68bc9a1343242443ca8e5ddcaa0000"
      }

    示例 - 更新记录

    此示例会更新 Teams 实体中具有指定 ID 的记录。

    1. 在 Configure connector task 对话框中,点击 Entities。
    2. 从 Entity 列表中选择 Teams。
    3. 选择 Update 操作,然后点击完成。
    4. 在连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
      {
            "displayName": "My Team Name Changed",
            "description": "Changed the description for my team"
          }
    5. 点击 filterClause,然后在默认值字段中输入 id = '953933bc-1024-4ce7-84dc-bae7f24dc2ca'。

    示例 - 删除记录

    此示例会删除 Group Owners 实体中具有指定 ID 的记录。

    1. 在 Configure connector task 对话框中,点击 Entities。
    2. 从 Entity 列表中选择 Group Owners。
    3. 选择 Delete 操作,然后点击完成。

    使用 Terraform 创建连接

    您可以使用 Terraform 资源创建新连接。

    如需了解如何应用或移除 Terraform 配置,请参阅基本 Terraform 命令。

    如需查看用于创建连接的 Terraform 模板示例,请参阅模板示例。

    使用 Terraform 创建此连接时,您必须在 Terraform 配置文件中设置以下变量:

    参数名称 数据类型 必需 说明
    default_queue_name STRING 错误 默认队列的名称,在执行操作时可能会被替换。
    default_topic_name STRING 错误 默认主题的名称,在执行操作时可能会被替换。
    存储桶 STRING 正确 项目内 tibjms.jar 所在的存储桶的名称。
    对象 ID STRING 正确 相应存储桶中 .jar 文件的名称。

    在集成中使用 Microsoft Teams 连接

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

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

    向 Google Cloud 社区寻求帮助

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

    后续步骤