使用 REST API 管理 Microsoft Fabric HorizonDB

目前的預覽上線程序會在入口網站中建立 Fabric HorizonDB 資料庫。 這並不表示支援 REST 管理作業。 在進行自動化之前,請先確認目前的 Microsoft Fabric REST API 參考文件已明確指出,在您的預覽版本中支援 HorizonDB 作業。

Important

Fabric HorizonDB 目前處於公開預覽階段。 功能、限制與行為可能會在正式推出前發生變化。 如需更多資訊,請參閱 Microsoft Fabric 預覽功能。

Prerequisites

  • 已指派為活動容量的合格 Fabric 工作區。
  • Fabric HorizonDB 於工作區所在區域的可用性。
  • 具有針對已發行的 Fabric HorizonDB 作業所列出的工作區角色和 API 權限的 Microsoft Entra 身分識別。
  • 工作區識別碼。
  • 可取得並保護 Fabric API 權杖的用戶端。

使用已發布的合約

在撰寫自動化之前:

  1. 開啟 Fabric REST API 參考。
  2. 確認此操作明確適用於 Fabric HorizonDB。
  3. 使用已記錄的路徑、API 版本、驗證需求、權限、標頭、請求主體、回應主體及狀態處理。
  4. 請遵循任何參考的 Microsoft Fabric 指引,處理非同步操作、錯誤、節流及重試。
  5. 在將操作加入管理自動化之前,請先在非生產工作區進行測試。

不要從其他 Fabric 資料庫產品複製端點、負載、項目類型或屬性。 在公開預覽期間,支援的合約可能會變更,因此在部署前請先驗證自動化是否符合目前的參考文件。

僅包含適用的 HorizonDB 架構識別為可寫入的屬性。 如果沒有適用的合約可用,請使用入口網站建立程序,而非從其他 Fabric 項目推斷 API。

取得 Fabric API 令牌

使用支援的 Microsoft Entra 驗證函式庫或 Azure CLI 來取得 Fabric API 的存取權杖。 公開的 Fabric 資源為:

https://api.fabric.microsoft.com

對於需要範圍的 OAuth 函式庫,請使用目前 Fabric REST API 驗證指引中所描述的範圍。 不要將令牌放進網址、日誌、提交檔案或指令轉錄檔中。

依照文件說明透過 HTTPS 傳送令牌。 只授予呼叫身份該操作所需的權限。

傳送並驗證請求

  1. 從目前的 Fabric HorizonDB API 參考建立請求。

  2. 僅包含已記錄的值與可寫入屬性。

  3. 提交請求,並依照操作參考所指定的方式處理回應。

  4. 儲存服務回傳的非敏感資源、請求、操作及關聯識別碼,以便排除故障。

  5. 管理操作成功後,請再次閱讀該項目並確認設定是否有效。

  6. 建立時,請以資料庫建立者身分連線並執行:

    SELECT
        current_database() AS database_name,
        current_user AS signed_in_user,
        current_setting('server_version') AS server_version,
        clock_timestamp() AS validated_at;
    

在目前預覽版中,只有建立資料庫的 Microsoft Entra 身份才能連接至 PostgreSQL。 管理 API 權限不會啟用服務主體或受控識別的 PostgreSQL 連線。

安全處理錯誤

  • 將已記錄在文件中的回應與錯誤契約視為權威。
  • 在重試前修正驗證與授權失敗。
  • 僅在已發布操作指引將請求識別為安全可重試時,才使用有限制重試。
  • 不要記錄存取權杖、授權標頭、包含敏感值的請求主體,或未經審核的服務回應。
  • 在聯絡客服之前,請先保留關聯資訊。
  • 刪除前,請先檢視相依關係。 在公開預覽時,將刪除視為不可逆。