使用 Azure 数据工厂(预览版)从 QuickBooks Online 复制数据

适用于: Azure 数据工厂

本文概述了如何使用 Azure 数据工厂中的复制活动从 QuickBooks Online 复制数据。 它是基于概述复制活动总体的复制活动概述一文。

重要

此连接器目前提供预览版。 欢迎试用并提供反馈。 若要在解决方案中使用预览版连接器的依赖项,请联系 Azure 客户支持

支持的功能

以下活动支持此 QuickBooks 连接器:

可以将数据从 QuickBooks Online 复制到任何受支持的接收器数据存储。 有关复制活动支持作为源/接收器的数据存储列表,请参阅支持的数据存储表。

此连接器支持 QuickBooks OAuth 2.0 身份验证。

入门

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

使用 UI 创建一个到 QuickBooks 的链接服务

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

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

    屏幕截图,显示如何使用 Azure 数据工厂 UI 创建新的链接服务。

  2. 搜索 QuickBooks 并选择 QuickBooks 连接器。

    QuickBooks 连接器的屏幕截图。

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

    QuickBooks 的链接服务配置的屏幕截图。

连接器配置详细信息

对于特定于 QuickBooks 连接器的数据工厂实体,以下部分提供有关用于定义这些实体的属性的详细信息。

链接服务属性

QuickBooks 链接的服务支持以下属性:

属性 说明 必需
type type 属性必须设置为:QuickBooks
connectionProperties 一组属性,定义如何连接到 QuickBooks。
connectionProperties 下:
endpoint QuickBooks Online 服务器的终结点。 (即 quickbooks.api.intuit.com)
companyId QuickBooks 公司授权的公司 ID。 有关如何查找公司 ID 的信息,请参阅如何查找我的公司 ID
consumerKey 用于 OAuth 2.0 身份验证的 QuickBooks Online 应用程序的客户端 ID。 可从此处了解详细信息。
consumerSecret 用于 OAuth 2.0 身份验证的 QuickBooks Online 应用程序的客户端密码。 将此字段标记为 SecureString 以安全地存储它,或引用存储在 Azure Key Vault 中的机密
refreshToken 与 QuickBooks 应用程序关联的 OAuth 2.0 刷新令牌。 可从此处了解详细信息。 请注意,刷新令牌将在 180 天后到期。 客户需要定期更新刷新令牌。
将此字段标记为 SecureString 以安全地存储它,或引用存储在 Azure Key Vault 中的机密
useEncryptedEndpoints 指定是否使用 HTTPS 加密数据源终结点。 默认值为 true。

示例:

{
    "name": "QuickBooksLinkedService",
    "properties": {
        "type": "QuickBooks",
        "typeProperties": {
            "connectionProperties": {
                "endpoint": "quickbooks.api.intuit.com",
                "companyId": "<company id>",
                "consumerKey": "<consumer key>", 
                "consumerSecret": {
                     "type": "SecureString",
                     "value": "<clientSecret>"
                },
                "refreshToken": {
                     "type": "SecureString",
                     "value": "<refresh token>"
                },
                "useEncryptedEndpoints": true
            }
        }
    }
}

数据集属性

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

若要从 QuickBooks Online 复制数据,请将数据集的 type 属性设置为 QuickBooksObject。 支持以下属性:

属性 说明 必需
type 数据集的 type 属性必须设置为:QuickBooksObject
tableName 表的名称。 否(如果指定了活动源中的“query”)

示例

{
    "name": "QuickBooksDataset",
    "properties": {
        "type": "QuickBooksObject",
        "typeProperties": {},
        "schema": [],
        "linkedServiceName": {
            "referenceName": "<QuickBooks linked service name>",
            "type": "LinkedServiceReference"
        }
    }
}

复制活动属性

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

QuickBooks 作为源

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

属性 说明 必需
type 复制活动 source 的 type 属性必须设置为:QuickBooksSource
query 使用自定义 SQL 查询读取数据。 例如:"SELECT * FROM "Bill" WHERE Id = '123'" 否(如果指定了数据集中的“tableName”)

示例:

"activities":[
    {
        "name": "CopyFromQuickBooks",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<QuickBooks input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "QuickBooksSource",
                "query": "SELECT * FROM \"Bill\" WHERE Id = '123' "
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

从 Quickbooks Desktop 复制数据

此服务中的复制活动不能直接从 Quickbooks Desktop 复制数据。 若要从 Quickbooks Desktop 复制数据,请将 Quickbooks 数据导出到一个逗号分隔值 (CSV) 文件,然后将该文件上传到 Azure Blob 存储。 可以使用此服务从其中将数据复制到所选的接收器。

Lookup 活动属性

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

后续步骤

有关复制活动支持作为源和接收器的数据存储的列表,请参阅支持的数据存储