Azure Synapse

Azure Synapse 連接器可讓您連線至 Azure Synapse SQL 集區，並使用 SQL 擷取及更新 Azure Synapse 資料。

事前準備

使用 Azure Synapse 連接器前，請先完成下列工作：

  • 在 Google Cloud 專案中：
    • 確認已設定網路連線。如要瞭解網路模式，請參閱「網路連線」。
    • 將 roles/connectors.admin IAM 角色授予設定連接器的使用者。
    • 將下列 IAM 角色授予要用於連接器的服務帳戶：
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      服務帳戶是特殊的 Google 帳戶類型，主要用於代表需要驗證且必須取得授權才能存取 Google API 資料的非人類使用者。如果您沒有服務帳戶，請務必建立服務帳戶。詳情請參閱「建立服務帳戶」。

    • 啟用下列服務：
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (連接器 API)

      如要瞭解如何啟用服務，請參閱「啟用服務」。

    如果先前未為專案啟用這些服務或權限，系統會在設定連接器時提示您啟用。

設定連接器

連線是特定資料來源的連線，也就是說，如果您有多個資料來源，則必須為每個資料來源建立個別的連線。如要建立連線，請按照下列步驟操作：

  1. 在 Cloud 控制台中，前往「Integration Connectors」>「Connections」頁面，然後選取或建立 Google Cloud 專案。

    前往「連線」頁面

  2. 按一下「+ 建立新連線」，開啟「建立連線」頁面。
  3. 在「位置」部分，選擇連線的位置。
    1. 區域：從下拉式清單中選取位置。

      支援的連接器地區包括：

      如需所有支援地區的清單，請參閱「位置」一節。

    2. 點按「Next」。
  4. 在「連線詳細資料」部分中，完成下列操作：
    1. 連接器：從可用連接器的下拉式清單中選取「Azure Synapse」。
    2. 連接器版本：從可用版本的下拉式清單中選取連接器版本。
    3. 在「Connection Name」欄位中，輸入連線例項的名稱。

      連線名稱必須符合下列條件：

      • 連線名稱可以包含英文字母、數字或連字號。
      • 字母必須為小寫。
      • 連線名稱的開頭必須是英文字母，結尾則須為英文字母或數字。
      • 連結名稱不得超過 49 個半形字元。
    4. 您可以選擇輸入連線例項的說明。
    5. 服務帳戶：選取具備必要角色的服務帳戶。
    6. 視需要設定連線節點設定：

      • 節點數量下限：輸入連線節點數量下限。
      • 節點數量上限：輸入連線節點數量上限。

      節點是用來處理交易的連線單位 (或備用資源)。處理的交易量越多，就需要越多節點；反之，處理的交易量越少，就需要越少節點。如要瞭解節點對連接器定價的影響，請參閱「 連線節點的定價」。如果您未輸入任何值，系統預設會將最小節點設為 2 (以提高可用性)，並將最大節點設為 50。

    7. Azure 用戶群：此屬性會指定用於存取資料的 Microsoft Azure 用戶群。
    8. 資料庫：此屬性會指定無伺服器 SQL 集區或專屬 SQL 集區中的 Synapse 資料庫名稱。
    9. 在「目的地」下方輸入下列屬性：
      • 目的地類型：從下拉式選單中選取「Host Addrress」
      • 主機 1：輸入 SQL 儲存桶端點
      • Port 1：輸入 SQL 端點的通訊埠
      .
    10. 您可以視需要輸入下列 SSL 屬性：
      • 啟用安全資料傳輸層：這個核取方塊屬性可指定是否要啟用安全資料傳輸層。
      • 信任存放區：此屬性會指定信任存放區。您可以選取圓形按鈕，從「公開」、「私人」或「不安全連線」中選取信任存放區。
      • 自訂信任儲存庫：這個屬性可用來選取含有 PEM 格式自訂信任儲存庫的祕密。
      • SSL 用戶端憑證：此屬性會指定 SSL 用戶端憑證。
      • SSL 用戶端私密金鑰：此屬性會以 PEM 格式指定 SSL 用戶端私密金鑰。
      • SSL 用戶端憑證金鑰密碼：此屬性會指定 SSL 用戶端私密金鑰密碼。
    11. 您可以按一下「+ 新增標籤」，以鍵/值組合的形式為連線新增標籤。
    12. 點按「Next」。
  5. 在「Authentication」部分中，輸入驗證詳細資料。
    1. 選取「驗證類型」並輸入相關詳細資料。

      Azure Synapse 連線支援下列驗證類型：

      • 使用者密碼
      • Azure AD

      2. 如要瞭解如何設定這些驗證類型，請參閱「設定驗證」。

    2. 點按「Next」。
  6. 查看：查看連線和驗證詳細資料。
  7. 按一下 [建立]。

設定驗證機制

根據要使用的驗證方法輸入詳細資料。

  • 使用者密碼
    • 使用者名稱：輸入資料庫使用者名稱。
    • 密碼：Secret Manager 密鑰，內含與使用者名稱相關聯的密碼。
  • Azure AD
    • 用戶端 ID：用於要求存取權憑證的用戶端 ID。您可以在 Azure 入口網站中建立的已連結應用程式總覽中找到這項資訊。
    • 範圍：以半形逗號分隔的所需範圍清單。
    • 用戶端密鑰：包含帳戶存取金鑰的 Secret Manager 密鑰。
    • 授權網址：您在建立 OAuth 用戶端時產生的授權網址。 請使用下列格式輸入網址：https://login.microsoftonline.com/TENANT_IDENTIFIER/oauth2/v2.0/authorize?prompt=consent。 例如 https://login.microsoftonline.com/9bxxxxxxxxx8112/oauth2/v2.0/authorize?prompt=consent。

建立連線後的額外步驟

如果您選用 OAuth 2.0 - Authorization code 進行驗證，則必須在建立連線後執行下列額外步驟：

  1. 在「Connections」(連線) 頁面中，找出新建立的連線。

    請注意，新連接器的狀態會是「需要授權」。

  2. 按一下「需要授權」。

    這會顯示「Edit authorization」窗格。

  3. 將「Redirect URI」值複製到外部應用程式。
  4. 驗證授權詳細資料。
  5. 按一下「Authorize」。

    如果授權成功，連線頁面中的連線狀態會設為「Active」。

重新授權授權碼

如果您使用 Authorization code 驗證類型，且在 Azure Synapse 應用程式中進行任何設定變更，則必須重新授權 Azure Synapse 連線。如要重新授權連線，請按照下列步驟操作：

  1. 在「Connections」(連線) 頁面中，按一下所需連線。

    系統會開啟連線詳細資料頁面。

  2. 按一下「編輯」即可編輯連結詳細資料。
  3. 在「驗證」部分確認「OAuth 2.0 - 授權碼」詳細資料。

    視需要進行必要的變更。

  4. 按一下 [儲存]。系統會將您導向連線詳細資料頁面。
  5. 在「驗證」部分中，按一下「編輯授權」。畫面上會顯示「Authorize」窗格。
  6. 按一下「Authorize」。

    如果授權成功，「連線」頁面中的連線狀態就會設為「啟用」。

實體、作業和動作

所有整合連接器都為已連結應用程式的物件提供一層抽象層。您只能透過這個抽象層存取應用程式的物件。抽象概念會以實體、作業和動作的形式提供給您。

  • 實體： 實體可視為已連結應用程式或服務中的物件或屬性集合。實體的定義與連接器至連接器的定義不同。舉例來說，在資料庫連接器中，資料表是實體；在檔案伺服器連接器中，資料夾是實體；在訊息系統連接器中，佇列是實體。

    不過，連接器可能不支援或沒有任何實體，在這種情況下，Entities 清單會是空白。

  • 作業： 作業是指您可對實體執行的活動。您可以對實體執行下列任一操作：

    從可用清單中選取實體後，系統會產生可用於該實體的作業清單。如需作業的詳細說明，請參閱連接器工作中的實體作業。不過，如果連接器不支援任何實體作業，則 Operations 清單中不會列出這些不支援的作業。

  • 動作： 動作是透過連接器介面提供給整合項目的一流函式。動作可讓您變更實體或多個實體，而這些變更會因連接器而異。通常，動作會包含一些輸入參數和輸出參數。不過，連接器可能不支援任何動作，在這種情況下，Actions 清單會為空白。

系統限制

Azure Synapse 連接器每個節點每秒最多可處理 4 筆交易，並會限制超出此限制的交易。根據預設，Integration Connectors 會為連線分配 2 個節點 (可提高可用性)。

如要瞭解 Integration Connectors 適用的限制，請參閱「限制」一節。

支援的資料類型

以下為此連接器支援的資料類型：

  • BIGINT
  • BINARY
  • BIT
  • CHAR
  • DATE
  • DATETIME
  • DATETIME2
  • DATETIMEOFFSET
  • DECIMAL
  • FLOAT
  • DECIMAL
  • FLOAT
  • INT
  • 金錢
  • NCHAR
  • NVARCHAR
  • REAL
  • LSEG
  • SMALLDATETIME
  • SMALLINT
  • SMALLMONEY
  • TINYINT
  • UNIQUEIDENTIFIER
  • VARBINARY
  • VARCHAR

動作

Azure Synapse 連接器可讓您以 Azure Synapse 支援的格式執行儲存程序和自訂 SQL 查詢。為了執行自訂 SQL 查詢，連接器會提供「執行自訂查詢」動作。

如要建立自訂查詢，請按照下列步驟操作：

  1. 按照詳細操作說明 新增連接器工作。
  2. 設定連接器工作時，請在要執行的動作類型中選取「動作」。
  3. 在「Action」清單中，選取「Execute custom query」，然後按一下「Done」。

    圖片：顯示 execute-custom-query-action 圖片：顯示 execute-custom-query-action

  4. 展開「Task input」部分，然後執行下列操作：
    1. 在「Timeout after」欄位中，輸入要等待多久時間才執行查詢。

      預設值：180 秒。

    2. 在「資料列數量上限」欄位中，輸入要從資料庫傳回的資料列數量上限。

      預設值：25。

    3. 如要更新自訂查詢，請按一下「編輯自訂指令碼」。系統會開啟「Script editor」對話方塊。

      顯示自訂 SQL 查詢的圖片 顯示自訂 SQL 查詢的圖片

    4. 在「Script editor」對話方塊中輸入 SQL 查詢，然後按一下「Save」。

      您可以在 SQL 陳述式中使用問號 (?) 代表單一參數，該參數必須在查詢參數清單中指定。舉例來說，下列 SQL 查詢會選取 Employees 資料表中與 LastName 資料欄指定值相符的所有資料列：

      SELECT * FROM Employees where LastName=?

    5. 如果您在 SQL 查詢中使用了問號，請按一下每個問號旁的「+ 新增參數名稱」，新增參數。執行整合作業時，這些參數會依序取代 SQL 查詢中的問號 (?)。舉例來說，如果您新增了三個問號 (?)，就必須依序新增三個參數。

      顯示 add-query-param 的圖片 顯示 add-query-param 的圖片

      如要新增查詢參數，請按照下列步驟操作：

      1. 在「類型」清單中，選取參數的資料類型。
      2. 在「Value」欄位中輸入參數的值。
      3. 如要新增多個參數，請按一下「+ 新增查詢參數」。

實體操作範例

範例：列出實體的記錄

本範例會列出 Users 實體的記錄。

  1. 在 Configure connector task 對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取 Users。
  3. 選取 List 作業，然後按一下「Done」。
  4. 在「Connector」工作的「Task Input」部分，您可以根據需求設定「filterClause」。

    舉例來說，如果將篩選條件子句設為 employeeCode='5100' and startDate='2010-01-01 00:00:00'，系統就只會列出 employeeCode 為 5100 且 startDate 為 2010-01-01 00:00:00 的記錄。

範例：從實體取得單一記錄

這個範例會從 Users 實體擷取記錄。

  1. 在 Configure connector task 對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取 User。
  3. 選取 Get 作業，然後按一下「Done」。
  4. 在「Connectors」任務的「Task Input」部分，按一下「entityId」，然後在「Default Value」欄位中輸入 103032。

    其中 103032 是 Users 實體的主鍵值。

範例：從實體中刪除記錄

這個範例會從 Users 實體中刪除記錄。

  1. 在 Configure connector task 對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取 Users。
  3. 選取 Delete 作業，然後按一下「Done」。
  4. 在「Connectors」任務的「Task Input」部分，按一下「entityId」，然後在「Default Value」欄位中輸入 113132。

    或者，如果實體具有複合式主鍵，而非指定 entityId，您可以設定 filterClause。例如：employeeCode='5100' and startDate='2010-01-01 00:00:00'。

範例：在實體中建立記錄

這個範例會在 Users 實體中建立記錄。

  1. 在 Configure connector task 對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取 Users。
  3. 選取 Create 運算，然後按一下「Done」。
  4. 在「Connectors」任務的「Task Input」部分，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似以下的值：
    {
"employeeCode": "5100",
"startDate": "2010-01-01 00:00:00.0",
"country": "US"
}

    5. 如果整合成功，連接器工作 connectorOutputPayload 欄位就會包含建立作業的回應。

範例：更新實體中的記錄

這個範例會更新 Users 實體中的記錄。

  1. 在 Configure connector task 對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取 Users。
  3. 選取 Update 運算，然後按一下「Done」。
  4. 在「Connectors」任務的「Task Input」部分，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似以下的值：
    {
"country": "IN"
}
  5. 在「Connectors」任務的「Task Input」部分，按一下「entityId」，然後在「Default Value」欄位中輸入 113132。

    或者，如果實體具有複合式主鍵，而非指定 entityId，您可以設定 filterClause。例如：employeeCode='5100' and startDate='2010-01-01 00:00:00'。

    6. 如果整合成功，連接器工作 connectorOutputPayload 欄位就會包含更新作業的回應。

在整合中使用 Azure Synapse 連線

建立連線後，即可在 Apigee Integration 和 Application Integration 中使用。您可以透過「連接器」工作，在整合中使用連線。

  • 如要瞭解如何在 Apigee Integration 中建立及使用連接器工作，請參閱「連接器工作」。
  • 如要瞭解如何在 Application Integration 中建立及使用連接器工作，請參閱「連接器工作」。

向 Google Cloud 社群尋求協助

如有任何問題，歡迎在 雲端論壇中發問，並與 Google Cloud 社群成員討論這個連接器。

後續步驟