使用 Azure 数据工厂或 Synapse Analytics（预览版）从 Square 复制数据

2024-12-31

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

本文概述如何使用 Azure 数据工厂或 Synapse Analytics 管道中的复制活动从 Square 复制数据。它是基于概述复制活动总体的复制活动概述一文。

重要

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

注意

目前，此连接器不支持沙盒帐户。

支持的功能

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

支持的功能	IR
复制活动（源/-）	① ②
Lookup 活动	① ②

① Azure 集成运行时 ② 自承载集成运行时

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

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

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

入门

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

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

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

浏览到 Azure 数据工厂或 Synapse 工作区中的“管理”选项卡并选择“链接服务”，然后单击“新建”：
- Azure 数据工厂
- Azure Synapse
搜索 Square 并选择 Square 连接器。
配置服务详细信息、测试连接并创建新的链接服务。

连接器配置详细信息

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

链接服务属性

Square 链接的服务支持以下属性：

属性	描述	必需
type	type 属性必须设置为：Square	是
connectionProperties	定义如何连接到 Square 的一组属性。	是
在 `connectionProperties` 下：
host	Square 实例的 URL。（即 mystore.mysquare.com）	是
clientId	与 Square 应用程序关联的客户端 ID。	是
clientSecret	与 Square 应用程序关联的客户端密码。将此字段标记为 SecureString 以安全地存储它，或引用存储在 Azure Key Vault 中的机密。	是
accessToken	从 Square 获得的访问令牌。通过向经过身份验证的用户请求显式权限，授予对 Square 帐户的有限访问权限。 OAuth 访问令牌在发布后 30 天过期，但刷新令牌不会过期。刷新令牌可以刷新访问令牌。将此字段标记为 SecureString 以安全地存储它，或引用存储在 Azure Key Vault 中的机密。	是
refreshToken	从 Square 获得的刷新令牌。用于在当前的访问令牌过期时获取新的访问令牌。将此字段标记为 SecureString 以安全地将其存储在工厂中，或引用存储在 Azure Key Vault 中的机密。	否
useEncryptedEndpoints	指定是否使用 HTTPS 加密数据源终结点。默认值为 true。	否
useHostVerification	指定通过 TLS 进行连接时是否要求服务器证书中的主机名与服务器的主机名匹配。默认值为 true。	否
usePeerVerification	指定通过 TLS 进行连接时是否要验证服务器的标识。默认值为 true。	否

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

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

重要

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

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

示例：

{
    "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 数据集支持的属性列表。

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

属性	描述	必需
type	数据集的 type 属性必须设置为：SquareObject	是
tableName	表的名称。	否（如果指定了活动源中的“query”）

示例

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

复制活动属性

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

Square 作为源

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

属性	描述	必需
type	复制活动 source 的 type 属性必须设置为：SquareSource	是
query	使用自定义 SQL 查询读取数据。例如：`"SELECT * FROM Business"`。	否（如果指定了数据集中的“tableName”）

示例：

"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>"
            }
        }
    }
]

查找活动属性

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

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

共用方式為