Groups - Get Groups

Service:

Power BI REST APIs

API Version:

v1.0

Vrátí seznam pracovních prostorů, ke kterým má uživatel přístup.

Oprávnění

Toto volání rozhraní API lze volat pomocí profilu instančního objektu. Další informace najdete v tématu Profily instančního objektu v Power BI Embedded.

Požadovaný obor

Workspace.Read.All nebo Workspace.ReadWrite.All

Omezení

• Aktualizace uživatelských oprávnění pro pracovní prostory chvíli trvá a při volání rozhraní API nemusí být okamžitě dostupná. Pokud chcete aktualizovat uživatelská oprávnění, použijte volání rozhraní API Pro aktualizaci uživatelských oprávnění .
  
  

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}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
$filter	query		string	Filtruje výsledky na základě logické podmínky.
$skip	query		integer int32	Přeskočí prvních n výsledků.
$top	query		integer int32	Vrátí pouze prvních n výsledků.

Odpovědi

Name	Typ	Description
200 OK	Groups	OK

Příklady

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"
    }
  ]
}

Definice

Name	Description
AzureResource	Odpověď s podrobnostmi o prostředku Azure vlastněného uživatelem, jako je pracovní prostor služby Log Analytics.
DefaultDatasetStorageFormat	Výchozí formát úložiště datové sady ve skupině
Group	Skupina Power BI
Groups	Obálka odpovědi OData pro seznam skupin Power BI

AzureResource

Odpověď s podrobnostmi o prostředku Azure vlastněného uživatelem, jako je pracovní prostor služby Log Analytics.

Name	Typ	Description
id	string	Identifikátor prostředku v Power BI.
resourceGroup	string	Skupina prostředků v rámci předplatného, ve kterém se prostředek nachází.
resourceName	string	Název prostředku.
subscriptionId	string	Předplatné Azure, ve kterém se prostředek nachází.

DefaultDatasetStorageFormat

Výchozí formát úložiště datové sady ve skupině

Name	Typ	Description
Large	string	Velký formát úložiště datové sady
Small	string	Formát úložiště malých datových sad

Group

Skupina Power BI

Name	Typ	Description
capacityId	string	ID kapacity
dataflowStorageId	string	ID účtu úložiště toku dat Power BI
defaultDatasetStorageFormat	DefaultDatasetStorageFormat	Výchozí formát úložiště datové sady v pracovním prostoru Vráceno pouze v případech, kdy isOnDedicatedCapacity je true
id	string	ID pracovního prostoru
isOnDedicatedCapacity	boolean	Jestli je skupina přiřazená k vyhrazené kapacitě
isReadOnly	boolean	Jestli je skupina jen pro čtení
logAnalyticsWorkspace	AzureResource	Pracovní prostor služby Log Analytics přiřazený ke skupině Vrátí se pouze při načítání jedné skupiny.
name	string	Název skupiny

Groups

Obálka odpovědi OData pro seznam skupin Power BI

Name	Typ	Description
odata.context	string	Kontext OData
value	Group[]	Seznam skupin