適用於:
Azure Data Factory
Azure Synapse Analytics
秘訣
Data Factory in Microsoft Fabric 是下一代的 Azure Data Factory,擁有更簡單的架構、內建 AI 及新功能。 如果你是資料整合新手,建議先從 Fabric Data Factory 開始。 現有的 ADF 工作負載可升級至 Fabric,以存取資料科學、即時分析與報告等新能力。
本文說明如何在 Azure Data Factory 或 Synapse Analytics 管線中使用複製活動,從 Square 複製資料。 本文是根據複製活動概觀一文,該文提供複製活動的一般概觀。
重要事項
Square 連接器 1.0 版本目前正 處於拆除階段。 建議你將 Square 連接器從 版本 1.0 升級到 2.0。
支援的功能
此 Square 連接器支援下列功能:
| 支援的功能 | IR |
|---|---|
| 複製作業(來源/-) | (1) (2) |
| 查閱活動 | (1) (2) |
(1) Azure 整合執行時 (2) 自架整合執行時
如需支援做為來源/接收器的資料存放區清單,請參閱支援的資料存放區表格。
此服務提供的內建驅動程式可啟用連線,因此,您不需手動安裝任何驅動程式,即可使用此連接器。
連接器支援本 article 中的Windows版本。
先決條件
如果你的資料儲存位於本地網路、Azure虛擬網路或亞馬遜虛擬私人雲中,你需要配置一個自架整合執行時來連接它。
如果你的資料儲存是雲端管理型資料服務,你可以使用Azure Integration Runtime。 如果存取權限限制在防火牆規則中核准的 IP,你可以將 Azure Integration Runtime IPs 加入允許清單。
你也可以在 Azure Data Factory 中使用 managed 虛擬網路整合執行時功能,無需安裝和設定自架整合執行環境即可存取本地網路。
如需 Data Factory 所支援之網路安全性機制和選項的詳細資訊,請參閱 數據存取策略。
附註
版本 2.0 支援自架整合執行時版本 5.56.0.0 或更高版本。
開始使用
若要使用管線執行複製活動,您可以使用下列其中一個工具或 SDK:
使用 UI 建立 Square 的連結服務
請依照以下步驟在 Azure 入口網站介面中建立與 Square 的連結服務。
請瀏覽 Azure Data Factory 或 Synapse 工作區的管理標籤,選擇連結服務,然後點選新建:
搜尋 Square 並選取 Square 連接器。
設定服務詳細資料,測試連線,然後建立新的連結服務。
連接器設定詳細資料
下列各節提供屬性的相關詳細資料,這些屬性是用來定義 Square 連接器專屬的 Data Factory 實體。
連結服務屬性
Square 連接器現支援版本 2.0。 請參閱本節 (部分機器翻譯),從 1.0 版升級您的 Square 連接器版本。 如需屬性詳細資料,請參閱對應的章節。
2.0 版
Square 連結服務在套用版本 2.0 時支援以下屬性:
| 屬性 | 描述 | 必要 |
|---|---|---|
| 型別 | Type 屬性必須設定為:Square | 是 |
| 版本 | 您指定的版本。 該值為 2.0。 |
是 |
| 主持人 | Square 執行個體的 URL。 (亦即 mystore.mysquare.com) | 是 |
| clientId | 與您 Square 應用程式相關聯的用戶端識別碼。 | 是 |
| clientSecret | 與您 Square 應用程式相關聯的用戶端祕密。 將此欄位標記為 SecureString 以安全儲存,或參考儲存在 Azure Key Vault 的機密。 | 是 |
| accessToken | 自 Square 取得的存取權杖。 藉由向已驗證的使用者要求明確權限,授與 Square 帳戶的有限存取權。 OAuth 存取權杖在發行後的 30 天到期,但重新整理權杖不會到期。 可以透過重新整理權杖來重新整理存取權杖。 將此欄位標記為 SecureString 以安全儲存,或參考儲存在 Azure Key Vault 的機密。 如需存取權杖類型的詳細資訊,請參閱存取權杖類型。 |
是 |
| refreshToken | 從 Square 取得的重新整理權杖。 用於在目前存取權杖到期時取得新的存取權杖。 將此欄位標示為 SecureString,以便在 Factory 中安全儲存,或參考儲存在 Azure Key Vault 中的祕密。 |
否 |
| connectVia | Integration Runtime 用於連接資料儲存。 若未指定,則使用預設Azure Integration Runtime。 您可以使用自我裝載整合執行階段,而其版本應該是 5.56.0.0 或更新版本。 | 否 |
範例︰
{
"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 連結服務支援下列屬性:
| 屬性 | 描述 | 必要 |
|---|---|---|
| 型別 | Type 屬性必須設定為:Square | 是 |
| connectionProperties | 定義如何連接到 Square 的屬性群組。 | 是 |
在 connectionProperties底下: |
||
| 主持人 | Square 執行個體的 URL。 (亦即 mystore.mysquare.com) | 是 |
| clientId | 與您 Square 應用程式相關聯的用戶端識別碼。 | 是 |
| clientSecret | 與您 Square 應用程式相關聯的用戶端祕密。 將此欄位標記為 SecureString 以安全儲存,或參考儲存在 Azure Key Vault 的機密。 | 是 |
| accessToken | 自 Square 取得的存取權杖。 藉由向已驗證的使用者要求明確權限,授與 Square 帳戶的有限存取權。 OAuth 存取權杖在發行後的 30 天到期,但重新整理權杖不會到期。 可以透過重新整理權杖來重新整理存取權杖。 將此欄位標記為 SecureString 以安全儲存,或參考儲存在 Azure Key Vault 的機密。 如需存取權杖類型的詳細資訊,請參閱存取權杖類型。 |
是 |
| refreshToken | 從 Square 取得的重新整理權杖。 用於在目前存取權杖到期時取得新的存取權杖。 將此欄位標示為 SecureString,以便在 Factory 中安全儲存,或參考儲存在 Azure Key Vault 中的祕密。 |
否 |
| useEncryptedEndpoints | 指定是否使用 HTTPS 來加密資料來源端點。 預設值為 true。 | 否 |
| useHostVerification | 指定在透過 TLS 連線時,是否要求伺服器憑證中的主機名稱符合伺服器的主機名稱。 預設值為 true。 | 否 |
| usePeerVerification | 指定在透過 TLS 連線時,是否要驗證伺服器的身分識別。 預設值為 true。 | 否 |
| connectVia | Integration Runtime 用於連接資料儲存。 若未指定,則使用預設Azure Integration Runtime。 | 否 |
範例︰
{
"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 帳戶中資源的無限制連線 API 存取權。
OAuth 存取權杖可用來取得任何 Square 帳戶的已驗證和範圍連線 API 存取權。 當您的應用程式代表帳戶擁有者存取其他 Square 帳戶中的資源時,請使用這些權杖。 OAuth 存取權杖也可用來存取您自己的 Square 帳戶中的資源。
重要事項
若要在連結服務中執行 [測試連線],需要
MERCHANT_PROFILE_READ以取得限定範圍的 OAuth 存取權杖。 如需存取其他資料表的權限,請參閱 Square OAuth 權限參考。
透過個人存取權杖進行驗證只需要 accessToken,而透過 OAuth 進行驗證則需要 accessToken 和 refreshToken。 瞭解如何從這裡擷取存取權杖。
資料集屬性
如需可用來定義資料集的區段和屬性完整清單,請參閱資料集一文。 本節提供 Square 資料集所支援的屬性清單。
若要從 Square 複製資料,請將資料集的 type 屬性設定為 SquareObject。 以下是支援的屬性:
| 屬性 | 描述 | 必要 |
|---|---|---|
| 型別 | 資料集的類型屬性必須設定為 SquareObject | 是 |
| tableName | 資料表的名稱。 | 是的,2.0 版。 就版本 1.0 而言為非必要 (如果已指定活動來源中的「查詢」) |
範例
{
"name": "SquareDataset",
"properties": {
"type": "SquareObject",
"typeProperties": {},
"schema": [],
"linkedServiceName": {
"referenceName": "<Square linked service name>",
"type": "LinkedServiceReference"
}
}
}
複製活動屬性
如需可用來定義活動的區段和屬性完整清單,請參閱管線一文。 本節提供 Square 來源所支援的屬性清單。
Square 即來源
若要從 Square 複製資料,請將複製活動中的來源類型設定為 SquareSource。 複製活動的 source 區段支援下列屬性:
| 屬性 | 描述 | 必要 |
|---|---|---|
| 型別 | 複製活動來源的 type 屬性必須設定為:SquareSource | 是 |
| 查詢 | 使用自訂 SQL 查詢來讀取資料。 例如:"SELECT * FROM Business"。 |
否 (如果已指定資料集中的 "tableName") |
附註
query 2.0 版不支援。
範例︰
"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 的資料類型套用至服務使用的內部資料類型。 若要瞭解複製活動如何將來源架構和資料類型映射到匯入端,請參閱 架構和資料類型對應。
| Square 資料類型 | 過渡期服務資料類型 (針對 2.0 版) | 過渡期服務資料類型 (1.0 版) |
|---|---|---|
| 繩子 | 繩子 | 繩子 |
| 整數 | Int32 | Int32 |
| Long | Int64 | Int64 |
| 布林值 | 布林值 | 布林值 |
| Date | 繩子 | 不支援。 |
| 時間戳 | 繩子 | 不支援。 |
| 具有位移的時間戳記 | 繩子 | 不支援。 |
| 期間 (完整) | 繩子 | 繩子 |
| 時間 (僅限時間) | 繩子 | 繩子 |
| 金錢 | Int64 | Int64 |
查閱活動屬性
若要了解屬性的詳細資料,請參閱查閱活動。
Square 連接器生命週期和升級
下表顯示不同 Square 連接器版本的發行階段和變更記錄:
| 版本 | 發行階段 | 變更紀錄 |
|---|---|---|
| 1.0 版 | Removed | 不適用。 |
| 2.0 版 | 正式運作 | • 自我裝載整合執行階段版本應該是 5.56.0.0 或更新版本。 • 日期、時間戳記和具有位移的時間戳記會讀取為字串資料類型。 • useEncryptedEndpoints、useHostVerification、usePeerVerification 在連結服務中不受支援。 • query 不支援。 |
將 Square 連接器從版本 1.0 升級到 2.0 版本
在 [編輯連結服務] 頁面中,選取 [版本] 2.0。 如需詳細資訊,請參閱 連結服務 2.0 版屬性。
Square 連結服務 2.0 版的資料類型對應與 1.0 版的不同。 若要了解最新的資料類型對應,請參閱Square 的資料類型對應。
套用具有 5.56.0.0 版或更新版本的自我裝載整合執行階段。
query僅在 1.0 版中受支持。 您應該在 2.0 版中使用tableName而不是query。
相關內容
如需複製活動支援作為來源和接收器的資料存放區清單,請參閱支援的資料存放區。