Groups - Get Groups

Service:

Power BI REST APIs

API Version:

v1.0

傳回使用者可存取的工作區清單。

權限

此 API 呼叫可由服務主體設定檔呼叫。 如需詳細資訊，請參閱：Power BI Embedded中的服務主體設定檔。

必要範圍

Workspace.Read.All 或 Workspace.ReadWrite.All

限制

• 工作區的使用者權限需要一段時間才能更新，而且在使用 API 呼叫時可能無法立即使用。 若要重新整理使用者權限，請使用 重新整理使用者權限 API 呼叫。
  
  

GET https://api.powerbi.com/v1.0/myorg/groups

With optional parameters:

GET https://api.powerbi.com/v1.0/myorg/groups?$filter={$filter}&$top={$top}&$skip={$skip}

URI 參數

名稱	位於	必要	類型	Description
$filter	query		string	根據布林條件篩選結果
$skip	query		integer int32	略過前 n 個結果
$top	query		integer int32	只傳回前 n 個結果

回應

名稱	類型	Description
200 OK	Groups	確定

範例

Example

Get a list of workspaces using a filter example

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "sample group"
    },
    {
      "id": "3d9b93c6-7b6d-4801-a491-1738910904fd",
      "isReadOnly": false,
      "isOnDedicatedCapacity": true,
      "capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "defaultDatasetStorageFormat": "Small",
      "name": "marketing group"
    },
    {
      "id": "a2f89923-421a-464e-bf4c-25eab39bb09f",
      "isReadOnly": false,
      "isOnDedicatedCapacity": true,
      "capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "defaultDatasetStorageFormat": "Large",
      "name": "contoso",
      "dataflowStorageId": "d692ae06-708c-485e-9987-06ff0fbdbb1f"
    }
  ]
}

Get a list of workspaces using a filter example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups?$filter=contains(name,'marketing')%20or%20name%20eq%20'contoso'

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "3d9b93c6-7b6d-4801-a491-1738910904fd",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "marketing group"
    },
    {
      "id": "a2f89923-421a-464e-bf4c-25eab39bb09f",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "contoso",
      "dataflowStorageId": "d692ae06-708c-485e-9987-06ff0fbdbb1f"
    }
  ]
}

定義

名稱	Description
AzureResource	詳細說明使用者擁有 Azure 資源的回應，例如 Log Analytics 工作區。
DefaultDatasetStorageFormat	群組中的預設資料集儲存格式
Group	Power BI 群組
Groups	Power BI 群組清單的 OData 回應包裝函式

AzureResource

詳細說明使用者擁有 Azure 資源的回應，例如 Log Analytics 工作區。

名稱	類型	Description
id	string	Power BI 中資源的識別碼。
resourceGroup	string	資源所在訂用帳戶內的資源群組。
resourceName	string	資源名稱。
subscriptionId	string	資源所在的 Azure 訂用帳戶。

DefaultDatasetStorageFormat

群組中的預設資料集儲存格式

名稱	類型	Description
Large	string	大型資料集儲存格式
Small	string	小型資料集儲存體格式

Group

Power BI 群組

名稱	類型	Description
capacityId	string	容量識別碼
dataflowStorageId	string	Power BI 資料流程儲存體帳戶識別碼
defaultDatasetStorageFormat	DefaultDatasetStorageFormat	工作區中的預設資料集儲存格式。 只有在 為 時 isOnDedicatedCapacity 才會傳回 true
id	string	工作區識別碼
isOnDedicatedCapacity	boolean	群組是否已指派給專用容量
isReadOnly	boolean	群組是否為唯讀
logAnalyticsWorkspace	AzureResource	指派給群組的 Log Analytics 工作區。 只有在擷取單一群組時，才會傳回此專案。
name	string	組名

Groups

Power BI 群組清單的 OData 回應包裝函式

名稱	類型	Description
odata.context	string	OData 內容
value	Group[]	群組清單