使用 Power BI REST API

Power BI REST API 提供用於內嵌、管理、治理和使用者資源的服務端點。

使用 Power BI REST API,您可以執行下列動作:

  • 管理 Power BI 內容

  • 執行管理作業

  • 內嵌 Power BI 內容

注意

  • 某些 Power BI API 會將工作區稱為群組。 任何群組的參考都表示您正在使用工作區。

  • 存取 Power BI REST API 時,您的要求和回應內容和資料可能會由 Power BI 租使用者主區域以外的區域中的資料中心處理。

範圍

若要使用 Power BI REST API,您必須在 Azure 中註冊 Azure Active Directory (Azure AD) 應用程式。 Azure AD 應用程式會建立 Power BI REST 資源的權限,以便讓您存取 Power BI REST API。 若要瞭解如何註冊應用程式,請參閱 註冊 Azure AD 應用程式以搭配 Power BI 使用

註冊 Azure AD 應用程式之後,您可以使用 Azure AD (v1.0 進行驗證;ADAL) 或 Microsoft 身分識別平臺 (v2.0;MSAL) 端點。 若要深入瞭解這些驗證方法的運作方式,請參閱為何要更新至 v2.0 Microsoft 身分識別平臺 () ?

如需 Power BI 存取權限的詳細資訊,請參閱 Microsoft 身分識別平台端點中的權限和同意

使用服務主體

如果您使用 服務主體,則不需要範圍。 一旦您啟用要與 Power BI 搭配使用的服務主體,應用程式的 AD 許可權就不會再生效。 使用服務主體時,應用程式的許可權是透過 Power BI 管理入口網站來管理。 如需詳細資訊,請參閱啟用Power BI 服務系統管理員設定

新增範圍

若要將許可權新增至 Azure AD 應用程式,請遵循下列步驟:

  1. 在 Azure 中開啟您的應用程式。

  2. 從左側的 [ 管理] 底下,選取 [API 許可權]。

  3. 選取 [新增權限]。

  4. 在 [ 要求 API 許可權] 視窗中,選取 [Power BI 服務]。

  5. 選取 [委派的權限]。 隨即顯示 API 清單。

  6. 展開您要新增許可權的 API,然後選取您要新增的許可權。

  7. 選取 [新增權限]。

移除範圍

若要從 Azure AD 應用程式移除許可權,請遵循下列步驟:

  1. 在 Azure 中開啟您的應用程式。

  2. 從左側的 [ 管理] 底下,選取 [API 許可權]。

  3. 選取 [ 操作] 功能表 (許可權省略號) 。

  4. 選取 [移除權限]。

節流

Power BI 會使用節流來維護最佳效能和可靠性。 若要防止過度使用單一使用者的資源,Power BI 會限制每個使用者在時間範圍內呼叫的 API 呼叫數目。

當使用者在時間範圍期間傳送超過預先決定限制的要求數目時,Power BI 會短暫地節流該使用者的任何進一步要求。

當應用程式遇到節流時,Power BI 會傳回 HTTP 狀態碼 429 (回應中有 Retry-After HTTP 標頭) 太多要求,表示呼叫應用程式在提出新要求之前必須等候多少秒。

REST 作業群組

下表列出 Power BI REST API 作業群組。

作業群組 Description
管理員 使用管理工作的作業。
應用程式 使用應用程式的作業。
可用的功能 (英文) 傳回可用功能的作業。
容量 使用容量的作業。
儀表板 使用儀表板的作業。
資料流程儲存體帳戶 (英文) 使用資料流程儲存體帳戶的作業。
資料流程 使用資料流程的作業。
資料集 使用資料集的作業。
內嵌權杖 (英文) 使用內嵌權杖的作業。
閘道 使用閘道的作業。
群組 使用群組的作業。
匯入 (英文) 使用匯入的作業。
管線 使用部署管線的作業。
推送資料集 (英文) 使用推送資料集的作業。
報表 使用報表的作業。
範本應用程式 (英文) 使用範本應用程式的作業。
使用者 和使用者合作的作業。

後續步驟