Groups - Get Groups

Služba:

Power BI REST APIs

Verze rozhraní API:

v1.0

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

Povolení

Toto volání rozhraní API může volat instanční profil. 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 použití 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

S volitelnými parametry:

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	Vrátí podmnožinu výsledků na základě podmínky parametru dotazu filtru Odata .
$skip	query		integer (int32)	Přeskočí první n výsledků.
$top	query		integer (int32)	Vrátí pouze první 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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Objekt

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 (uuid)	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 (uuid)	Předplatné Azure, ve kterém se prostředek nachází.

DefaultDatasetStorageFormat

Výčet

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

Hodnota	Description
Small	Malý formát úložiště datových sad
Large	Formát úložiště velkých datových sad

Group

Objekt

Skupina Power BI

Name	Typ	Description
capacityId	string (uuid)	ID kapacity
dataflowStorageId	string (uuid)	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 (uuid)	ID pracovního prostoru
isOnDedicatedCapacity	boolean	Určuje, jestli je skupina přiřazená k vyhrazené kapacitě.
isReadOnly	boolean	Jestli je skupina určená jen pro čtení
logAnalyticsWorkspace	AzureResource	Pracovní prostor služby Log Analytics přiřazený ke skupině. Tato funkce se vrátí pouze při načítání jedné skupiny.
name	string	Název skupiny

Groups

Objekt

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

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