使用 Azure 数据工厂 或 Synapse Analytics 从 Zoho 复制数据(预览版)

适用于: Azure 数据工厂 Azure Synapse Analytics

重要

此连接器处于终止支持阶段。 建议通过安装驱动程序迁移到 ODBC 连接器 。

在本文中,我们概述了如何在 Azure 数据工厂 或 Synapse Analytics 管道中使用复制活动来从 Zoho 复制数据。 它建立在复制活动概述一文基础上,该文章提供了复制活动的总体概述。

支持的功能

此 Zoho 连接器支持以下功能:

支持的功能 IR
复制操作 (source/-) (1) (2)
查找操作 (1) (2)

(1) Azure集成运行时 (2) 自承载集成运行时

如需可以用作源/接收器的数据存储的列表,请参阅支持的数据存储表。

此连接器支持 Xero 访问令牌身份验证和 OAuth 2.0 身份验证。

该服务提供内置的驱动程序用于启用连接,因此使用此连接器无需手动安装任何驱动程序。

入门

若要使用管道执行复制活动,可以使用以下工具或 SDK 之一:

使用 UI 创建到 Zoho 的链接服务

使用以下步骤在Azure门户 UI 中创建到 Zoho 的链接服务。

  1. 浏览到 Azure 数据工厂或 Synapse 工作区中的“管理”选项卡,并选择“链接服务”,然后单击“新建”:

  2. 搜索“Zoho”并选择 Zoho 连接器。

    选择 Zoho 连接器。

  3. 配置服务详细信息、测试连接并创建新的链接服务。

    配置 Zoho 的关联服务。

连接器配置详细信息

以下部分提供了详细信息,说明如何使用特定于 Zoho 连接器的属性来定义数据工厂实体。

关联服务属性

Zoho 链接服务支持以下属性:

属性 描述 必需
类型 type 属性必须设置为:Zoho 是
连接属性 一组属性,定义如何连接到 Zoho。 是
在connectionProperties下:
终结点 Zoho 服务器的端点 (crm.zoho.com/crm/private)。 是
认证类型 允许的值为 OAuth_2.0 和 Access Token。 是
clientId 与 Zoho 应用程序关联的客户端 ID。 是,适用于 OAuth 2.0 身份验证
clientSecret 与 Zoho 应用程序关联的客户端密码。 将此字段标记为 SecureString 以安全地存储它,或引用存储在 Azure 密钥保管库 中的机密。 是,适用于 OAuth 2.0 身份验证
refreshToken 与 Zoho 应用程序关联的 OAuth 2.0 刷新令牌,用于在访问令牌到期时刷新访问令牌。 刷新令牌将永不过期。 若要获取刷新令牌,必须请求 offline access_type,请参阅本文 了解详细信息。
将此字段标记为 SecureString 以安全地存储它,或引用存储在 Azure 密钥保管库 中的机密。
是,适用于 OAuth 2.0 身份验证
accessToken 用于 Zoho 身份验证的访问令牌。 将此字段标记为 SecureString 以安全地存储它,或引用存储在 Azure 密钥保管库 中的机密。 是
使用加密端点 指定是否使用 HTTPS 加密数据源终结点。 默认值为 true。 否
使用主机验证 指定通过 TLS 进行连接时是否要求服务器证书中的主机名与服务器的主机名匹配。 默认值为 true。 否
usePeerVerification 指定通过 TLS 进行连接时是否要验证服务器的标识。 默认值为 true。 否

示例:OAuth 2.0 身份验证

{
    "name": "ZohoLinkedService",
    "properties": {
        "type": "Zoho",
        "typeProperties": {
            "connectionProperties": { 
                "authenticationType":"OAuth_2.0", 
                "endpoint": "crm.zoho.com/crm/private", 
                "clientId": "<client ID>", 
                "clientSecret": {
                    "type": "SecureString",
                    "value": "<client secret>"
                },
                "accessToken": {
                    "type": "SecureString",
                    "value": "<access token>"
                }, 
                "refreshToken": {
                    "type": "SecureString",
                    "value": "<refresh token>"
                }, 
                "useEncryptedEndpoints": true,
                "useHostVerification": true, 
                "usePeerVerification": true
            }
        }
    }
}

示例:访问令牌身份验证

{
    "name": "ZohoLinkedService",
    "properties": {
        "type": "Zoho",
        "typeProperties": {
            "connectionProperties": { 
                "authenticationType":"Access Token", 
                "endpoint": "crm.zoho.com/crm/private", 
                "accessToken": {
                    "type": "SecureString",
                    "value": "<access token>"
                }, 
                "useEncryptedEndpoints": true, 
                "useHostVerification": true, 
                "usePeerVerification": true
            }
        }
    }
}

数据集属性

有关可用于定义数据集的各部分和属性的完整列表,请参阅数据集一文。 本部分提供 Zoho 数据集支持的属性列表。

要从 Zoho 复制数据,请将数据集的 type 属性设置为“ZohoObject” 。 支持以下属性:

属性 描述 必需
类型 数据集的 type 属性必须设置为:ZohoObject 是
tableName 表的名称。 否(如果在活动源中指定了"query")

示例

{
    "name": "ZohoDataset",
    "properties": {
        "type": "ZohoObject",
        "typeProperties": {},
        "schema": [],
        "linkedServiceName": {
            "referenceName": "<Zoho linked service name>",
            "type": "LinkedServiceReference"
        }
    }
}

复制活动 属性

有关可用于定义活动的各部分和属性的完整列表,请参阅管道一文。 本部分提供 Zoho 数据源支持的属性列表。

Zoho 作为数据源

要从 Zoho 复制数据,请将复制活动中的源类型设置为“ZohoSource” 。 复制活动source部分支持以下属性:

属性 描述 必需
类型 复制活动的来源的类型属性必须设置为:ZohoSource 是
查询 使用自定义 SQL 查询读取数据。 例如:"SELECT * FROM Accounts"。 否(如果数据集中指定了“tableName”)

示例:

"activities":[
    {
        "name": "CopyFromZoho",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<Zoho input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "ZohoSource",
                "query": "SELECT * FROM Accounts"
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

查找活动属性

若要了解有关属性的详细信息,请查看 Lookup 活动。

为了获取复制活动支持的数据源和汇集列表,请参阅支持的数据存储。