使用 Azure 数据工厂 或 Synapse Analytics 从 Square 复制数据

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

本文概述了如何使用 Azure 数据工厂 或 Synapse Analytics 管道中的复制活动从 Square 复制数据。 基于提供复制活动一般概述的复制活动概述一文。

支持的功能

此 Square 连接器支持以下功能：

（1） Azure集成运行时 （2） 自承载集成运行时

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

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

连接器支持此 article 中的Windows版本。

先决条件

如果数据存储位于本地网络、Azure虚拟网络或 Amazon 虚拟私有云中，则需要配置自承载集成运行时以连接到它。

如果数据存储是托管的云数据服务，则可以使用Azure Integration Runtime。 如果访问仅限于防火墙规则中批准的 IP，则可以将 Azure Integration Runtime IP 添加到允许列表。

还可以在 Azure 数据工厂 中使用 托管虚拟网络集成运行时功能访问本地网络，而无需安装和配置自承载集成运行时。

要详细了解网络安全机制和数据工厂支持的选项，请参阅数据访问策略。

入门

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

• 复制数据工具
• Azure 门户
• .NET SDK
• Python SDK
• Azure PowerShell
• REST API
• Azure 资源管理器 模板

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

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

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

   • Azure 数据工厂
   • Azure Synapse

   

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

   

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

   

连接器配置详细信息

在以下部分中，将提供详细信息以说明哪些属性用于定义特定于 Square 连接器的数据工厂实体。

连接的服务属性

Square 连接器现在支持版本 2.0。 请参阅本部分，将 Square 连接器版本从 1.0 升级。 关于属性详情，请参阅对应部分。

• 版本 2.0
• 版本 1.0

版本 2.0

应用版本 2.0 时，Square 链接服务支持以下属性：

示例：

{
    "name": "SquareLinkedService",
    "properties": {
        "type": "Square",
        "version": "2.0",
        "typeProperties": {
            "host": "<e.g. mystore.mysquare.com>", 
            "clientId": "<client ID>", 
            "clientSecret": {
                "type": "SecureString",
                "value": "<clientSecret>"
            }, 
            "accessToken": {
                "type": "SecureString",
                "value": "<access token>"
            }, 
            "refreshToken": {
                "type": "SecureString",
                "value": "<refresh token>"
            }
        },
        "connectVia": {
            "referenceName": "<name of Integration Runtime>",
            "type": "IntegrationRuntimeReference"
        }
    }
}

版本 1.0

应用版本 1.0 时，Square 链接服务支持以下属性：

示例：

{
    "name": "SquareLinkedService",
    "properties": {
        "type": "Square",
        "typeProperties": {
            "connectionProperties": {
                "host": "<e.g. mystore.mysquare.com>", 
                "clientId": "<client ID>", 
                "clientSecret": {
                    "type": "SecureString",
                    "value": "<clientSecret>"
                }, 
                "accessToken": {
                    "type": "SecureString",
                    "value": "<access token>"
                }, 
                "refreshToken": {
                    "type": "SecureString",
                    "value": "<refresh token>"
                }, 
                "useEncryptedEndpoints": true, 
                "useHostVerification": true, 
                "usePeerVerification": true 
            }
        }
    }
}

访问令牌类型

Square 支持两种类型的访问令牌：个人和 OAuth 。

• 个人访问令牌用于对自己 Square 帐户中的资源进行无限制的 Connect API 访问。

• OAuth 访问令牌用于对任何 Square 帐户进行经过身份验证的、具有范围限制的 Connect API 访问。 当应用以帐户所有者名义访问其他 Square 帐户中的资源时，请使用它们。 OAuth 访问令牌还可用于访问自己 Square 帐户中的资源。

  重要

  若要在链接服务中执行测试连接，需要 MERCHANT_PROFILE_READ 来获取限定范围的 OAuth 访问令牌。 有关访问其他表的权限，请参阅 Square OAuth 权限参考。

通过个人访问令牌进行身份验证仅需要 accessToken，而通过 OAuth 进行身份验证则需要 accessToken 和 refreshToken。 在此处了解如何获取访问令牌。

数据集属性

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

要从 Square 复制数据，请将数据集的 type 属性设置为“SquareObject” 。 支持以下属性：

示例

{
    "name": "SquareDataset",
    "properties": {
        "type": "SquareObject",
        "typeProperties": {},
        "schema": [],
        "linkedServiceName": {
            "referenceName": "<Square linked service name>",
            "type": "LinkedServiceReference"
        }
    }
}

复制活动 属性

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

Square 作为数据源

要从 Square 复制数据，请将复制活动中的源类型设置为“SquareSource” 。 复制活动source部分支持以下属性：

示例：

"activities":[
    {
        "name": "CopyFromSquare",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<Square input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "SquareSource",
                "query": "SELECT * FROM Business"
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

Square 的数据类型映射

从 Square 复制数据时，以下映射适用于从 Square 的数据类型到服务使用的内部数据类型。 若要了解复制活动如何将源架构和数据类型映射到接收器，请参阅架构和数据类型映射。

查找活动属性

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

平方连接器生命周期和升级

下表显示了不同版本的 Square 连接器的发布阶段和更改日志：

将 Square 连接器从版本 1.0 升级到版本 2.0

1. 在 “编辑链接服务 ”页中，为版本选择 2.0。 有关详细信息，请参阅 链接服务版本 2.0 属性。

2. Square 链接服务版本 2.0 的数据类型映射与版本 1.0 的不同。 若要了解最新的数据类型映射，请参阅 Square 的数据类型映射。

3. 应用版本为 5.56.0.0 或更高的自托管集成运行时环境。

4. query 仅在版本 1.0 中受支持。 应在版本 2.0 中使用 tableName 而不是 query。

相关内容

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