Groups - Get Groups

Dienst:

Power BI REST APIs

API-Version:

v1.0

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

Erlaubnisse

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 nehmen Zeit in Anspruch, um aktualisiert zu 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

Mit optionalen Parametern:

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	Gibt eine Teilmenge einer Ergebnisse basierend auf der Odata-Filterabfrageparameterbedingung zurück.
$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	OKAY

Beispiele

Example

Get a list of workspaces using a filter example

Example

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

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 azure-Ressource im Besitz eines Benutzers wie einen Log Analytics-Arbeitsbereich detailiert.
DefaultDatasetStorageFormat	Das Standardmäßige Datasetspeicherformat in der Gruppe
Group	Eine Power BI-Gruppe
Groups	Der OData-Antwortwrapper für eine Liste von Power BI-Gruppen

AzureResource

Objekt

Eine Antwort, die eine azure-Ressource im Besitz eines Benutzers wie einen Log Analytics-Arbeitsbereich detailiert.

Name	Typ	Beschreibung
id	string (uuid)	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 (uuid)	Das Azure-Abonnement, in dem sich die Ressource befindet.

DefaultDatasetStorageFormat

Enumeration

Das Standardmäßige Datasetspeicherformat in der Gruppe

Wert	Beschreibung
Small	Kleines Dataset-Speicherformat
Large	Großes Dataset-Speicherformat

Group

Objekt

Eine Power BI-Gruppe

Name	Typ	Beschreibung
capacityId	string (uuid)	Die Kapazitäts-ID
dataflowStorageId	string (uuid)	Die Power BI-Speicherkonto-ID
defaultDatasetStorageFormat	DefaultDatasetStorageFormat	Das Standardspeicherformat des Datasets im Arbeitsbereich. Wird nur zurückgegeben, wenn isOnDedicatedCapacitytrue
id	string (uuid)	Die Arbeitsbereichs-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 beim Abrufen einer einzelnen Gruppe zurückgegeben.
name	string	Der Gruppenname

Groups

Objekt

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

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