共用方式為


使用 Azure Data Factory 或 Synapse Analytics 從 Zoho 複製資料 (預覽)

適用於:Azure Data Factory Azure Synapse Analytics

提示

試用 Microsoft Fabric 中的 Data Factory,這是適用於企業的全方位分析解決方案。 Microsoft Fabric 涵蓋從資料移動到資料科學、即時分析、商業智慧和報告的所有項目。 了解如何免費開始新的試用

重要

此連接器將於 2024 年 12 月 31 日淘汰。 建議您在該日期之前安裝驅動程式,以移轉至 ODBC 連接器

此文章概述如何使用 Azure Data Factory 或 Synapse Analytics 管線中的複製活動,從 Zoho 複製資料。 本文是根據複製活動概觀一文,該文提供複製活動的一般概觀。

支援的功能

此 Zoho 連接器支援下列功能:

支援的功能 IR
複製活動 (來源/-) (1) (2)
查閱活動 (1) (2)

① Azure 整合執行階段 ② 自我裝載整合執行階段

如需支援做為來源/接收器的資料存放區清單,請參閱支援的資料存放區表格。

此連接器支援 Xero 存取權杖驗證和 OAuth 2.0 驗證。

此服務提供的內建驅動程式可啟用連線,因此,您不需手動安裝任何驅動程式,即可使用此連接器。

開始使用

若要透過管線執行複製活動,您可以使用下列其中一個工具或 SDK:

使用 UI 建立 Zoho 的連結服務

使用下列步驟,在 Azure 入口網站 UI 中建立與 Zoho 的連結服務。

  1. 前往 Azure Data Factory 或 Synapse 工作區的 [管理] 索引標籤,選取 [連結服務],然後按一下 [新增]:

  2. 搜尋 Zoho,並選取 Zoho 連接器。

    選取 Zoho 連接器。

  3. 設定服務詳細資料,測試連線,然後建立新的連結服務。

    將連結服務設定為 Zoho。

連接器設定詳細資料

下列各節提供屬性的相關詳細資料,這些屬性是用來定義 Zoho 連接器專屬的 Data Factory 實體。

連結服務屬性

以下是針對 Zoho 已連結服務支援的屬性:

屬性 描述 必要
type type 屬性必須設定為:Zoho Yes
connectionProperties 定義如何連線至 Zoho 的屬性群組。 Yes
connectionProperties 之下:
endpoint Zoho 伺服器的端點 (crm.zoho.com/crm/private)。 Yes
authenticationType 允許值為:OAuth_2.0Access Token Yes
clientId 與 Zoho 應用程式相關聯的用戶端識別碼。 適用於 OAuth 2.0 驗證
clientSecret 與 Zoho 應用程式相關聯的用戶端祕密。 將此欄位標記為 SecureString 以便安全儲存,或參考 Azure Key Vault 中儲存的祕密 適用於 OAuth 2.0 驗證
refreshToken 與 Zoho 應用程式相關聯的 OAuth 2.0 重新整理權杖,用於在存取權杖到期時重新整理。 重新整理權杖永不過期。 若要取得重新整理權杖,則須要求 offline access_type,請閱讀此文章深入了解。
將此欄位標記為 SecureString 以便安全儲存,或參考 Azure Key Vault 中儲存的祕密
適用於 OAuth 2.0 驗證
accessToken 用於 Zoho 驗證的存取權杖。 將此欄位標記為 SecureString 以便安全儲存,或參考 Azure Key Vault 中儲存的祕密 Yes
useEncryptedEndpoints 指定是否使用 HTTPS 來加密資料來源端點。 預設值為 True。 No
useHostVerification 指定在透過 TLS 連線時,是否要求伺服器憑證中的主機名稱符合伺服器的主機名稱。 預設值為 True。 No
usePeerVerification 指定在透過 TLS 連線時,是否要驗證伺服器的身分識別。 預設值為 True。 No

範例: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 Yes
tableName 資料表的名稱。 否 (如果已指定活動來源中的「查詢」)

範例

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

複製活動屬性

如需可用來定義活動的區段和屬性完整清單,請參閱管線一文。 本節提供 Zoho 來源所支援的屬性清單。

Zoho 作為來源

若要從 Zoho 複製資料,請將複製活動中的來源類型設定為 ZohoSource。 複製活動的 source 區段支援下列屬性:

屬性 描述 必要
type 複製活動來源的 type 屬性必須設定為:ZohoSource Yes
query 使用自訂 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>"
            }
        }
    }
]

查閱活動屬性

若要了解屬性的詳細資料,請參閱查閱活動

如需複製活動支援作為來源和接收器的資料存放區清單,請參閱支援的資料存放區