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

發行項
10/25/2024

適用於：Azure Data Factory Azure Synapse Analytics

提示

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

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

重要

此連接器目前為預覽版。您可以親身體驗並提供意見反應。如果您需要依賴解決方案中的預覽連接器，請連絡 Azure 支援。

注意

目前，此連接器不支援沙箱帳戶。

支援的功能

此 Square 連接器支援下列功能：

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

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

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

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

連接器支援本文中的 Windows 版本。

開始使用

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

使用 UI 建立 Square 的連結服務

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

前往 Azure Data Factory 或 Synapse 工作區的 [管理] 索引標籤，選取 [連結服務]，然後按一下 [新增]：
- Azure Data Factory
- Azure Synapse
搜尋 Square 並選取 Square 連接器。
設定服務詳細資料，測試連線，然後建立新的連結服務。

連接器設定詳細資料

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

連結服務屬性

以下是針對 Square 已連結服務支援的屬性：

屬性	描述	必要
type	Type 屬性必須設定為：Square	Yes
connectionProperties	定義如何連接到 Square 的屬性群組。	Yes
`connectionProperties` 之下：
host	Square 執行個體的 URL。 (亦即 mystore.mysquare.com)	Yes
clientId	與您 Square 應用程式相關聯的用戶端識別碼。	Yes
clientSecret	與您 Square 應用程式相關聯的用戶端祕密。將此欄位標記為 SecureString 以便安全儲存，或參考 Azure Key Vault 中儲存的祕密。	Yes
accessToken	自 Square 取得的存取權杖。藉由向已驗證的使用者要求明確權限，授與 Square 帳戶的有限存取權。 OAuth 存取權杖在發行後的 30 天到期，但重新整理權杖不會到期。可以透過重新整理權杖來重新整理存取權杖。將此欄位標記為 SecureString 以便安全儲存，或參考 Azure Key Vault 中儲存的祕密。	Yes
refreshToken	從 Square 取得的重新整理權杖。用於在目前存取權杖到期時取得新的存取權杖。將此欄位標記為 SecureString 以將其安全地儲存，或參考 Azure Key Vault 中儲存的祕密。	No
useEncryptedEndpoints	指定是否使用 HTTPS 來加密資料來源端點。預設值為 True。	No
useHostVerification	指定在透過 TLS 連線時，是否要求伺服器憑證中的主機名稱符合伺服器的主機名稱。預設值為 True。	No
usePeerVerification	指定在透過 TLS 連線時，是否要驗證伺服器的身分識別。預設值為 True。	No

Square 支援兩種存取權杖：個人和 OAuth。

個人存取權杖可用來取得您自己 Square 帳戶中資源的無限制連線 API 存取權。
OAuth 存取權杖可用來取得任何 Square 帳戶的已驗證和範圍連線 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	資料集的類型屬性必須設定為 SquareObject	Yes
tableName	資料表的名稱。	否 (如果已指定活動來源中的「查詢」)

範例

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

複製活動屬性

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

Square 即來源

若要從 Square 複製資料，請將複製活動中的來源類型設定為 SquareSource。複製活動的 source 區段支援下列屬性：

屬性	描述	必要
type	複製活動來源的 type 屬性必須設定為：SquareSource	Yes
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>"
            }
        }
    }
]

查閱活動屬性

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

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

共用方式為

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

支援的功能

開始使用

使用 UI 建立 Square 的連結服務

連接器設定詳細資料

連結服務屬性

資料集屬性

複製活動屬性

Square 即來源

查閱活動屬性

意見反應

其他資源

共用方式為

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

支援的功能

開始使用

使用 UI 建立 Square 的連結服務

連接器設定詳細資料

連結服務屬性

資料集屬性

複製活動屬性

Square 即來源

查閱活動屬性

相關內容

意見反應

其他資源