Groups - Get Groups

Service:

Power BI REST APIs

API Version:

v1.0

Zwraca listę obszarów roboczych, do których użytkownik ma dostęp.

Uprawnienia

To wywołanie interfejsu API może być wywoływane przez profil jednostki usługi. Aby uzyskać więcej informacji, zobacz: Profile jednostki usługi w Power BI Embedded.

Zakres wymagany

Workspace.Read.All lub Workspace.ReadWrite.All

Ograniczenia

• Aktualizowanie uprawnień użytkownika dla obszarów roboczych może zająć trochę czasu i może nie być natychmiast dostępne podczas korzystania z wywołań interfejsu API. Aby odświeżyć uprawnienia użytkownika, użyj wywołania interfejsu API Odświeżanie uprawnień użytkownika .
  
  

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 identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
$filter	query		string	Filtruje wyniki na podstawie warunku logicznego
$skip	query		integer int32	Pomija pierwsze n wyników
$top	query		integer int32	Zwraca tylko pierwsze n wyników

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Groups	OK

Przykłady

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

Definicje

Nazwa	Opis
AzureResource	Odpowiedź szczegółowo opisująca należący do użytkownika zasób platformy Azure, taki jak obszar roboczy usługi Log Analytics.
DefaultDatasetStorageFormat	Domyślny format magazynu zestawu danych w grupie
Group	Grupa usługi Power BI
Groups	Otoka odpowiedzi OData dla listy grup usługi Power BI

AzureResource

Odpowiedź szczegółowo opisująca należący do użytkownika zasób platformy Azure, taki jak obszar roboczy usługi Log Analytics.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu w usłudze Power BI.
resourceGroup	string	Grupa zasobów w ramach subskrypcji, w której znajduje się zasób.
resourceName	string	Nazwa zasobu.
subscriptionId	string	Subskrypcja platformy Azure, w której znajduje się zasób.

DefaultDatasetStorageFormat

Domyślny format magazynu zestawu danych w grupie

Nazwa	Typ	Opis
Large	string	Format dużego magazynu zestawu danych
Small	string	Format magazynu małych zestawów danych

Group

Grupa usługi Power BI

Nazwa	Typ	Opis
capacityId	string	Identyfikator pojemności
dataflowStorageId	string	Identyfikator konta magazynu przepływu danych usługi Power BI
defaultDatasetStorageFormat	DefaultDatasetStorageFormat	Domyślny format magazynu zestawu danych w obszarze roboczym. Zwracane tylko wtedy, gdy isOnDedicatedCapacity jest true
id	string	Identyfikator obszaru roboczego
isOnDedicatedCapacity	boolean	Czy grupa jest przypisana do pojemności dedykowanej
isReadOnly	boolean	Czy grupa jest tylko do odczytu
logAnalyticsWorkspace	AzureResource	Obszar roboczy usługi Log Analytics przypisany do grupy. Jest to zwracane tylko w przypadku pobierania pojedynczej grupy.
name	string	Nazwa grupy

Groups

Otoka odpowiedzi OData dla listy grup usługi Power BI

Nazwa	Typ	Opis
odata.context	string	Kontekst OData
value	Group[]	Lista grup