Groups - Get Groups

Service:

Power BI REST APIs

API Version:

v1.0

Gibt eine Liste der Arbeitsbereiche zurück, auf die der Benutzer Zugriff hat.

Berechtigungen

Dieser API-Aufruf kann von einem Dienstprinzipalprofil aufgerufen werden. Weitere Informationen finden Sie unter Dienstprinzipalprofile in Power BI Embedded.

Erforderlicher Bereich

Workspace.Read.All oder Workspace.ReadWrite.All

Einschränkungen

• Benutzerberechtigungen für Arbeitsbereiche dauern, bis sie aktualisiert werden, und sind möglicherweise nicht sofort verfügbar, wenn API-Aufrufe verwendet werden. Verwenden Sie zum Aktualisieren von Benutzerberechtigungen den API-Aufruf Benutzerberechtigungen aktualisieren .
  
  

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-Parameter

Name	In	Erforderlich	Typ	Beschreibung
$filter	query		string	Filtert die Ergebnisse basierend auf einer booleschen Bedingung
$skip	query		integer int32	Überspringt die ersten n-Ergebnisse
$top	query		integer int32	Gibt nur die ersten n-Ergebnisse zurück.

Antworten

Name	Typ	Beschreibung
200 OK	Groups	OK

Beispiele

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

Definitionen

Name	Beschreibung
AzureResource	Eine Antwort, die eine benutzereigene Azure-Ressource wie einen Log Analytics-Arbeitsbereich enthält.
DefaultDatasetStorageFormat	Das Standarddatasetspeicherformat in der Gruppe
Group	Eine Power BI-Gruppe
Groups	Der OData-Antwort-Wrapper für eine Liste von Power BI-Gruppen

AzureResource

Eine Antwort, die eine benutzereigene Azure-Ressource wie einen Log Analytics-Arbeitsbereich enthält.

Name	Typ	Beschreibung
id	string	Ein Bezeichner für die Ressource in Power BI.
resourceGroup	string	Die Ressourcengruppe innerhalb des Abonnements, in dem sich die Ressource befindet.
resourceName	string	Der Name der Ressource.
subscriptionId	string	Das Azure-Abonnement, in dem sich die Ressource befindet.

DefaultDatasetStorageFormat

Das Standarddatasetspeicherformat in der Gruppe

Name	Typ	Beschreibung
Large	string	Speicherformat für großes Datasets
Small	string	Speicherformat für kleine Datasets

Group

Eine Power BI-Gruppe

Name	Typ	Beschreibung
capacityId	string	Die Kapazitäts-ID
dataflowStorageId	string	Die Id des Power BI-Dataflow-Speicherkontos
defaultDatasetStorageFormat	DefaultDatasetStorageFormat	Das Standarddatasetspeicherformat im Arbeitsbereich. Nur zurückgegeben, wenn isOnDedicatedCapacitytrue
id	string	Arbeitsbereich-ID
isOnDedicatedCapacity	boolean	Gibt an, ob die Gruppe einer dedizierten Kapazität zugewiesen ist
isReadOnly	boolean	Gibt an, ob die Gruppe schreibgeschützt ist
logAnalyticsWorkspace	AzureResource	Der Log Analytics-Arbeitsbereich, der der Gruppe zugewiesen ist. Dies wird nur zurückgegeben, wenn eine einzelne Gruppe abgerufen wird.
name	string	Der Gruppenname

Groups

Der OData-Antwort-Wrapper für eine Liste von Power BI-Gruppen

Name	Typ	Beschreibung
odata.context	string	OData-Kontext
value	Group[]	Die Liste der Gruppen