Admin - Groups GetGroupsAsAdmin

Referenz

Service:: Power BI REST APIs

API Version:: v1.0

Gibt eine Liste der Arbeitsbereiche für die organization zurück.

Berechtigungen

Der Benutzer muss über Administratorrechte (z. B. Office 365 globalen Administrator oder Power BI-Dienstadministrator) verfügen oder sich mithilfe eines Dienstprinzipals authentifizieren.
Delegierte Berechtigungen werden unterstützt.

Bei der Ausführung unter dienstprinizipaler Authentifizierung dürfen für eine App keine erforderlichen Administratoreinwilligungsvoreinstellungen für Power BI im Azure-Portal festgelegt sein.

Erforderlicher Bereich

Tenant.Read.All oder Tenant.ReadWrite.All

Nur bei der Authentifizierung über ein standardmäßiges delegiertes Administratorzugriffstoken relevant. Darf nicht vorhanden sein, wenn die Authentifizierung über einen Dienstprinzipal verwendet wird.

Einschränkungen

Maximal 50 Anforderungen pro Stunde oder 15 Anforderungen pro Minute und Mandant. Bei diesem Aufruf wird auch nach 30 Sekunden ein Timeout ausgeführt, um negative Auswirkungen auf die Power BI-Dienst zu vermeiden.

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$top={$top}

With optional parameters:

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand={$expand}&$filter={$filter}&$top={$top}&$skip={$skip}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
$top	query	True	integer int32	Gibt nur die ersten n-Ergebnisse zurück. Dieser Parameter ist obligatorisch und muss im Bereich von 1 bis 5000 liegen.
$expand	query		string	Akzeptiert eine durch Trennzeichen getrennte Liste von Datentypen, die in der Antwort inline erweitert wird. Unterstützt `users`, `reports`, `dashboards`, `datasets`, `dataflows`und `workbooks`.
$filter	query		string	Filtert die Ergebnisse basierend auf einer booleschen Bedingung
$skip	query		integer int32	Überspringt die ersten n-Ergebnisse. Verwenden Sie mit top, um Ergebnisse ab den ersten 5000 abzurufen.

Antworten

Name	Typ	Beschreibung
200 OK	AdminGroups	OK

Beispiele

Get deleted workspaces example.

Get orphaned workspaces example.

Get workspaces with their 'dashboards' expanded example

Get workspaces with their 'datasets' expanded example

Get workspaces with their 'datasets' expanded example.

Get workspaces with their 'reports' expanded example

Get workspaces with their 'users' expanded example.

Get workspaces with their 'workbooks' expanded example

Get deleted workspaces example.

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$filter=state eq 'Deleted'&$top=100

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Sample Group 2",
      "description": "Deleted sample group",
      "type": "Workspace",
      "state": "Deleted"
    }
  ]
}

Get orphaned workspaces example.

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=users&$filter=(not users/any()) or (not users/any(u: u/groupUserAccessRight eq Microsoft.PowerBI.ServiceContracts.Api.GroupUserAccessRight'Admin'))&$top=100

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "d5caa808-8c91-400a-911d-06af08dbcc31",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Orphaned Group",
      "description": "Sample orphan group",
      "type": "Workspace",
      "state": "Active",
      "hasWorkspaceLevelSettings": false,
      "users": []
    }
  ]
}

Get workspaces with their 'dashboards' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=dashboards&$top=100

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "94E57E92-CEE2-486D-8CC8-218C97200579",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "capacityMigrationStatus": "Migrated",
      "description": "shorter description",
      "type": "Workspace",
      "state": "Removing",
      "name": "a",
      "hasWorkspaceLevelSettings": false,
      "dashboards": [
        {
          "id": "4668133c-ae3f-42fb-ad7c-214a8623280c",
          "displayName": "SQlAzure-Refresh.pbix",
          "isReadOnly": false
        },
        {
          "id": "a8f18ca7-63e8-4220-bc1c-f576ec180b98",
          "displayName": "cdvc",
          "isReadOnly": false
        }
      ]
    }
  ]
}

Get workspaces with their 'datasets' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=datasets&$top=100

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "94E57E92-CEE2-486D-8CC8-218C97200579",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "capacityMigrationStatus": "Migrated",
      "description": "shorter description",
      "type": "Workspace",
      "state": "Removing",
      "name": "a",
      "hasWorkspaceLevelSettings": false,
      "datasets": [
        {
          "id": "8ce96c50-85a0-4db3-85c6-7ccc3ed46523",
          "name": "SQlAzure-Refresh",
          "addRowsAPIEnabled": false,
          "configuredBy": "admin@granularcontrols.ccsctp.net",
          "isRefreshable": true,
          "isEffectiveIdentityRequired": false,
          "isEffectiveIdentityRolesRequired": false,
          "isOnPremGatewayRequired": false,
          "targetStorageMode": "Abf",
          "createdDate": "2019-04-30T21:35:15.867-07:00",
          "ContentProviderType": "PbixInImportMode",
          "isInPlaceSharingEnabled": false
        },
        {
          "id": "7d6a4f72-1906-4e08-a469-bd6bc1ab7b69",
          "name": "NESGames",
          "addRowsAPIEnabled": false,
          "configuredBy": "admin@granularcontrols.ccsctp.net",
          "isRefreshable": true,
          "isEffectiveIdentityRequired": false,
          "isEffectiveIdentityRolesRequired": false,
          "isOnPremGatewayRequired": false,
          "targetStorageMode": "Abf",
          "createdDate": "2019-04-30T21:35:15.867-07:00",
          "ContentProviderType": "PbixInImportMode",
          "isInPlaceSharingEnabled": false
        }
      ]
    }
  ]
}

Get workspaces with their 'datasets' expanded example.

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=datasets

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "e380d1d0-1fa6-460b-9a90-1a5c6b02414c",
      "isReadOnly": false,
      "isOnDedicatedCapacity": true,
      "capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "defaultDatasetStorageFormat": "Small",
      "name": "Sample Group 1",
      "description": "Sample group",
      "type": "Workspace",
      "state": "Active",
      "hasWorkspaceLevelSettings": true,
      "datasets": [
        {
          "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
          "name": "SalesMarketing",
          "addRowsAPIEnabled": false,
          "configuredBy": "john@contoso.com",
          "isRefreshable": true,
          "isEffectiveIdentityRequired": false,
          "isEffectiveIdentityRolesRequired": false,
          "isOnPremGatewayRequired": false,
          "isInPlaceSharingEnabled": false,
          "encryption": {
            "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
            "encryptionStatus": "InSyncWithWorkspace"
          }
        }
      ]
    },
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Sample Group 2",
      "description": "Deleted sample group",
      "type": "Workspace",
      "state": "Deleted",
      "datasets": []
    }
  ]
}

Get workspaces with their 'reports' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=reports&$top=100

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "EC1EE11F-845D-495E-82A3-9DAC2072305A",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "capacityMigrationStatus": "Migrated",
      "description": "cvcv",
      "type": "Workspace",
      "state": "Active",
      "name": "WSv2Test12",
      "hasWorkspaceLevelSettings": true,
      "reports": []
    },
    {
      "id": "94E57E92-CEE2-486D-8CC8-218C97200579",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "capacityMigrationStatus": "Migrated",
      "description": "shorter description",
      "type": "Workspace",
      "state": "Removing",
      "name": "a",
      "hasWorkspaceLevelSettings": false,
      "reports": [
        {
          "id": "5DBA60B0-D9A7-42AE-B12C-6D9D51E7739A",
          "reportType": "PowerBIReport",
          "name": "SQlAzure-Refresh",
          "datasetId": "8ce96c50-85a0-4db3-85c6-7ccc3ed46523"
        },
        {
          "id": "197E5C3C-D2F3-42D8-A536-875FB6D7D48C",
          "reportType": "PowerBIReport",
          "name": "NESGames",
          "datasetId": "7d6a4f72-1906-4e08-a469-bd6bc1ab7b69"
        }
      ]
    }
  ]
}

Get workspaces with their 'users' expanded example.

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=users&$top=100

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "e380d1d0-1fa6-460b-9a90-1a5c6b02414c",
      "isReadOnly": false,
      "isOnDedicatedCapacity": true,
      "capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "defaultDatasetStorageFormat": "Small",
      "name": "Sample Group 1",
      "description": "Sample group",
      "type": "Workspace",
      "state": "Active",
      "hasWorkspaceLevelSettings": false,
      "users": [
        {
          "emailAddress": "john@contoso.com",
          "groupUserAccessRight": "Admin"
        }
      ]
    },
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Sample Group 2",
      "description": "Deleted sample group",
      "type": "Workspace",
      "state": "Deleted",
      "users": []
    }
  ]
}

Get workspaces with their 'workbooks' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=workbooks&$top=100

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "94E57E92-CEE2-486D-8CC8-218C97200579",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "description": "shorter description",
      "type": "Workspace",
      "state": "Removing",
      "hasWorkspaceLevelSettings": false,
      "name": "a",
      "workbooks": [
        {
          "name": "My Excel sheet",
          "datasetId": "8ce96c50-85a0-4db3-85c6-7ccc3ed46523"
        }
      ]
    }
  ]
}

Definitionen

Name	Beschreibung
AdminDashboard	Eine Power BI-Dashboard von Admin-APIs zurückgegeben. Die API gibt eine Teilmenge der folgenden Liste von Dashboard Eigenschaften zurück. Die Teilmenge hängt von der API namens, den Aufruferberechtigungen und der Verfügbarkeit von Daten in der Power BI-Datenbank ab.
AdminDataflow	Die Metadaten eines Dataflows, der von Admin-APIs zurückgegeben wird. Im Folgenden finden Sie eine Liste der Eigenschaften, die für einen Dataflow zurückgegeben werden können. Nur eine Teilmenge der Eigenschaften wird abhängig von der aufgerufenen API, den Aufruferberechtigungen und der Verfügbarkeit der Daten in der Power BI-Datenbank zurückgegeben.
AdminDataset	Ein von Admin APIs zurückgegebenes Power BI-Dataset. Die API gibt eine Teilmenge der folgenden Liste der Dataseteigenschaften zurück. Die Teilmenge hängt von der API namens, den Aufruferberechtigungen und der Verfügbarkeit der Daten in der Power BI-Datenbank ab.
AdminGroup	Eine von Administrator-APIs zurückgegebene Power BI-Gruppe
AdminGroups	Der OData-Antwort wrapper für eine Liste von Power BI-Gruppen, die von Admin-APIs zurückgegeben werden
AdminReport	Ein von Admin APIs zurückgegebener Power BI-Bericht. Die API gibt eine Teilmenge der folgenden Liste der Berichtseigenschaften zurück. Die Teilmenge hängt von der API namens, den Aufruferberechtigungen und der Verfügbarkeit von Daten in der Power BI-Datenbank ab.
AdminTile	Eine Power BI-Kachel, die von Admin-APIs zurückgegeben wird.
AzureResource	Eine Antwort, die eine benutzereigene Azure-Ressource wie einen Log Analytics-Arbeitsbereich enthält.
DashboardUser	Ein Power BI-Benutzerzugriffsrechteintrag für eine Dashboard
DashboardUserAccessRight	Das Zugriffsrecht, das der Benutzer für die Dashboard hat (Berechtigungsstufe)
DataflowUser	Ein Power BI-Benutzerzugriffsrechteintrag für einen Dataflow
DataflowUserAccessRight	Das Zugriffsrecht, das ein Benutzer für den Dataflow hat (Berechtigungsstufe)
DatasetQueryScaleOutSettings	Abfragen von Horizontalskalierungseinstellungen eines Datasets
DatasetUser	Ein Power BI-Benutzerzugriffsrechteintrag für ein Dataset
DatasetUserAccessRight	Das Zugriffsrecht, das der Benutzer für das Dataset hat (Berechtigungsstufe)
DefaultDatasetStorageFormat	Das Standarddatasetspeicherformat in der Gruppe
DependentDataflow	Ein abhängiger Power BI-Dataflow
Encryption	Verschlüsselungsinformationen für ein Dataset
EncryptionStatus	Datasetverschlüsselung status
GroupType	Der Gruppentyp
GroupUser	Ein Power BI-Benutzer mit Zugriff auf den Arbeitsbereich
GroupUserAccessRight	Das Zugriffsrecht (Berechtigungsstufe), das ein Benutzer im Arbeitsbereich hat
PrincipalType	Der Prinzipaltyp
ReportUser	Ein Power BI-Benutzerzugriffsrechteintrag für einen Bericht
ReportUserAccessRight	Das Zugriffsrecht, das der Benutzer für den Bericht hat (Berechtigungsstufe)
ServicePrincipalProfile	Ein Power BI-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Lösung mit mehreren Mandanten.
Subscription	Ein E-Mail-Abonnement für ein Power BI-Element (z. B. einen Bericht oder eine Dashboard)
SubscriptionUser	Ein Power BI-E-Mail-Abonnementbenutzer
Workbook	Eine Power BI-Arbeitsmappe

AdminDashboard

Eine Power BI-Dashboard von Admin-APIs zurückgegeben. Die API gibt eine Teilmenge der folgenden Liste von Dashboard Eigenschaften zurück. Die Teilmenge hängt von der API namens, den Aufruferberechtigungen und der Verfügbarkeit von Daten in der Power BI-Datenbank ab.

Name	Typ	Beschreibung
appId	string	Die App-ID, die nur zurückgegeben wird, wenn die Dashboard zu einer App gehört
displayName	string	Der Anzeigename des Dashboard
embedUrl	string	Die Einbettungs-URL des Dashboard
id	string	Die Dashboard-ID
isReadOnly	boolean	Gibt an, ob der Dashboard schreibgeschützt ist
subscriptions	Subscription[]	(Leerer Wert) Die Abonnementdetails für ein Power BI-Element (z. B. einen Bericht oder eine Dashboard). Diese Eigenschaft wird in einer bevorstehenden Version aus der Nutzlastantwort entfernt. Sie können Abonnementinformationen für einen Power BI-Bericht abrufen, indem Sie berichtsabonnements abrufen als Admin API-Aufruf verwenden.
tiles	AdminTile[]	Die Kacheln, die zum Dashboard
users	DashboardUser[]	(Leerer Wert) Die Dashboard Benutzerzugriffsdetails. Diese Eigenschaft wird in einer bevorstehenden Version aus der Nutzlastantwort entfernt. Sie können Benutzerinformationen zu einem Power BI-Dashboard abrufen, indem Sie den Api-Aufruf "Dashboardbenutzer abrufen" als Admin API-Aufruf oder den PostWorkspaceInfo-API-Aufruf mit dem `getArtifactUsers` Parameter verwenden.
webUrl	string	Die Web-URL des Dashboard
workspaceId	string	Die Arbeitsbereichs-ID (GUID) des Dashboard. Diese Eigenschaft wird nur in GetDashboardsAsAdmin zurückgegeben.

AdminDataflow

Die Metadaten eines Dataflows, der von Admin-APIs zurückgegeben wird. Im Folgenden finden Sie eine Liste der Eigenschaften, die für einen Dataflow zurückgegeben werden können. Nur eine Teilmenge der Eigenschaften wird abhängig von der aufgerufenen API, den Aufruferberechtigungen und der Verfügbarkeit der Daten in der Power BI-Datenbank zurückgegeben.

Name	Typ	Beschreibung
configuredBy	string	Der Dataflowbesitzer
description	string	Beschreibung des Dataflows
modelUrl	string	Eine URL zur Dataflowdefinitionsdatei (model.json)
modifiedBy	string	Der Benutzer, der den Dataflow geändert hat
modifiedDateTime	string	Datum und Uhrzeit der letzten Änderung des Dataflows
name	string	Der Dataflowname
objectId	string	Die Dataflow-ID
users	DataflowUser[]	(Leerer Wert) Die Datenflussbenutzerzugriffsdetails. Diese Eigenschaft wird in einer bevorstehenden Version aus der Nutzlastantwort entfernt. Sie können Benutzerinformationen zu einem Power BI-Dataflow abrufen, indem Sie dataflow-Benutzer als Admin API-Aufruf oder den PostWorkspaceInfo-API-Aufruf mit dem `getArtifactUser` Parameter verwenden.
workspaceId	string	Die Dataflow-Arbeitsbereichs-ID.

AdminDataset

Ein von Admin APIs zurückgegebenes Power BI-Dataset. Die API gibt eine Teilmenge der folgenden Liste der Dataseteigenschaften zurück. Die Teilmenge hängt von der API namens, den Aufruferberechtigungen und der Verfügbarkeit der Daten in der Power BI-Datenbank ab.

Name	Typ	Beschreibung
ContentProviderType	string	Der Inhaltsanbietertyp für das Dataset
CreateReportEmbedURL	string	Einbettungs-URL zum Erstellen eines Berichts im Dataset
CreatedDate	string	Datum und Uhrzeit der Dataseterstellung
Encryption	Encryption	Datasetverschlüsselungsinformationen. Gilt nur, wenn `$expand` angegeben wird.
IsEffectiveIdentityRequired	boolean	Gibt an, ob das Dataset eine effektive Identität erfordert, die Sie in einem GenerateToken-API-Aufruf senden müssen.
IsEffectiveIdentityRolesRequired	boolean	Gibt an, ob die Sicherheit auf Zeilenebene in der Pbix-Datei von Power BI definiert ist. Wenn ja, müssen Sie eine Rolle angeben.
IsInPlaceSharingEnabled	boolean	Gibt an, ob das Dataset für externe Benutzer freigegeben werden kann, um es in ihrem eigenen Mandanten zu verwenden
IsOnPremGatewayRequired	boolean	Ob das Dataset ein lokales Datengateway erfordert
IsRefreshable	boolean	Gibt an, ob das Dataset aktualisiert werden kann oder nicht. Ein aktualisierbares Power BI-Dataset ist ein Dataset, das mindestens einmal aktualisiert wurde oder für das ein gültiger Aktualisierungszeitplan vorhanden ist.
QnaEmbedURL	string	Das Dataset Q&A Einbettungs-URL
addRowsAPIEnabled	boolean	Ob das Dataset das Hinzufügen neuer Zeilen zulässt
configuredBy	string	Der Datasetbesitzer
description	string	Beschreibung des Datasets
id	string	Die Dataset-ID
name	string	Der Datasetname
queryScaleOutSettings	DatasetQueryScaleOutSettings	Abfragen von Horizontalskalierungseinstellungen eines Datasets
targetStorageMode	string	Der Datasetspeichermodus
upstreamDataflows	DependentDataflow[]	Die Liste aller Dataflows, von der dieses Element abhängt
users	DatasetUser[]	(Leerer Wert) Die Details des Datasetbenutzerzugriffs. Diese Eigenschaft wird in einer bevorstehenden Version aus der Nutzlastantwort entfernt. Sie können Benutzerinformationen zu einem Power BI-Element (z. B. einem Bericht oder einem Dashboard) abrufen, indem Sie die Get Dataset Users as Admin API oder die PostWorkspaceInfo-API mit dem `getArtifactUsers` Parameter verwenden.
webUrl	string	Die Web-URL des Datasets
workspaceId	string	Die Dataset-Arbeitsbereichs-ID. Diese Eigenschaft wird nur in GetDatasetsAsAdmin zurückgegeben.

AdminGroup

Eine von Administrator-APIs zurückgegebene Power BI-Gruppe

Name	Typ	Beschreibung
capacityId	string	Die Kapazitäts-ID
dashboards	AdminDashboard[]	Die Dashboards, die zur Gruppe gehören
dataflowStorageId	string	Die Id des Power BI-Dataflow-Speicherkontos
dataflows	AdminDataflow[]	Die Dataflows, die zur Gruppe gehören
datasets	AdminDataset[]	Die Datasets, die zur Gruppe gehören
defaultDatasetStorageFormat	DefaultDatasetStorageFormat	Das Standarddatasetspeicherformat im Arbeitsbereich. Nur zurückgegeben, wenn `isOnDedicatedCapacitytrue`
description	string	Die Gruppenbeschreibung
hasWorkspaceLevelSettings	boolean	Gibt an, ob der Arbeitsbereich über benutzerdefinierte Einstellungen verfügt
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
pipelineId	string	Die Bereitstellungspipeline-ID, der der Arbeitsbereich zugewiesen ist.
reports	AdminReport[]	Die Berichte, die zur Gruppe gehören
state	string	Der Gruppenstatus
type	GroupType	Der Typ der zurückgegebenen Gruppe.
users	GroupUser[]	(Leerer Wert) Die Benutzer, die zur Gruppe gehören, und ihre Zugriffsrechte. Diese Eigenschaft wird in einer bevorstehenden Version aus der Nutzlastantwort entfernt. Sie können Benutzerinformationen zu einem Power BI-Element (z. B. einem Bericht oder einem Dashboard) abrufen, indem Sie den API-Aufruf "Gruppenbenutzer als Admin abrufen" oder den PostWorkspaceInfo-API-Aufruf mit dem `getArtifactUsers` Parameter verwenden.
workbooks	Workbook[]	Die Arbeitsmappen, die zur Gruppe gehören

AdminGroups

Der OData-Antwort wrapper für eine Liste von Power BI-Gruppen, die von Admin-APIs zurückgegeben werden

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

AdminReport

Ein von Admin APIs zurückgegebener Power BI-Bericht. Die API gibt eine Teilmenge der folgenden Liste der Berichtseigenschaften zurück. Die Teilmenge hängt von der API namens, den Aufruferberechtigungen und der Verfügbarkeit von Daten in der Power BI-Datenbank ab.

Name	Typ	Beschreibung
appId	string	Die App-ID, die nur zurückgegeben wird, wenn der Bericht zu einer App gehört
createdBy	string	Der Berichtsbesitzer. Nur für Berichte verfügbar, die nach Juni 2019 erstellt wurden.
createdDateTime	string	Datum und Uhrzeit der Berichtserstellung
datasetId	string	Die Dataset-ID des Berichts
description	string	Beschreibung des Berichts
embedUrl	string	Die Einbettungs-URL des Berichts
id	string	Die Berichts-ID
isOwnedByMe	boolean	Ermitteln Sie, ob der Bericht vom aktuellen Benutzer erstellt wird.
modifiedBy	string	Der letzte Benutzer, der den Bericht geändert hat
modifiedDateTime	string	Datum und Uhrzeit der letzten Änderung des Berichts
name	string	Der Name des Berichts
originalReportId	string	Die tatsächliche Berichts-ID, wenn der Arbeitsbereich als App veröffentlicht wird.
reportType	enum: PaginatedReport PowerBIReport	Der Berichtstyp
subscriptions	Subscription[]	(Leerer Wert) Die Abonnementdetails für ein Power BI-Element (z. B. einen Bericht oder eine Dashboard). Diese Eigenschaft wird in einer bevorstehenden Version aus der Nutzlastantwort entfernt. Sie können Abonnementinformationen für einen Power BI-Bericht abrufen, indem Sie berichtsabonnements abrufen als Admin API-Aufruf verwenden.
users	ReportUser[]	(Leerer Wert) Die Benutzerzugriffsdetails für einen Power BI-Bericht. Diese Eigenschaft wird in einer bevorstehenden Version aus der Nutzlastantwort entfernt. Sie können Benutzerinformationen für einen Power BI-Bericht abrufen, indem Sie berichtsbenutzer als Admin API-Aufruf oder den PostWorkspaceInfo-API-Aufruf mit dem `getArtifactUsers` Parameter verwenden.
webUrl	string	Die Web-URL des Berichts
workspaceId	string	Die Arbeitsbereichs-ID (GUID) des Berichts. Diese Eigenschaft wird nur in GetReportsAsAdmin zurückgegeben.

AdminTile

Eine Power BI-Kachel, die von Admin-APIs zurückgegeben wird.

Name	Typ	Beschreibung
colSpan	integer	Die Anzahl der Kachelspannenspalten
datasetId	string	Die Dataset-ID. Verfügbar nur für Kacheln, die aus einem Bericht oder mithilfe eines Datasets erstellt wurden, z. B. Q&A-Kacheln.
embedData	string	Die Einbettungsdaten für die Kachel
embedUrl	string	Die Einbettungs-URL der Kachel
id	string	Die Kachel-ID
reportId	string	Die Berichts-ID. Nur für Kacheln verfügbar, die aus einem Bericht erstellt wurden.
rowSpan	integer	Die Anzahl der Kachelspannzeilen
title	string	Der Anzeigename der Kachel

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.

DashboardUser

Ein Power BI-Benutzerzugriffsrechteintrag für eine Dashboard

Name	Typ	Beschreibung
dashboardUserAccessRight	DashboardUserAccessRight	Das Zugriffsrecht, das der Benutzer für die Dashboard hat (Berechtigungsstufe)
displayName	string	Anzeigename des Prinzipals
emailAddress	string	E-Mail-Adresse des Benutzers
graphId	string	Bezeichner des Prinzipals in Microsoft Graph. Nur für Administrator-APIs verfügbar.
identifier	string	Bezeichner des Prinzipals
principalType	PrincipalType	Der Prinzipaltyp
profile	ServicePrincipalProfile	Ein Power BI-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Mehrinstanzenlösung.
userType	string	Typ des Benutzers.

DashboardUserAccessRight

Das Zugriffsrecht, das der Benutzer für die Dashboard hat (Berechtigungsstufe)

Name	Typ	Beschreibung
None	string	Keine Berechtigung für Inhalte in Dashboard
Owner	string	Gewährt Lese-, Schreib- und erneuten Zugriff auf Inhalte im Bericht
Read	string	Gewährt Lesezugriff auf Inhalte in Dashboard
ReadCopy	string	Gewährt Lese- und Kopierzugriff auf Inhalte in Dashboard
ReadReshare	string	Gewährt lese- und erneuten Zugriff auf Inhalte in Dashboard
ReadWrite	string	Gewährt Lese- und Schreibzugriff auf Inhalte in Dashboard

DataflowUser

Ein Power BI-Benutzerzugriffsrechteintrag für einen Dataflow

Name	Typ	Beschreibung
DataflowUserAccessRight	DataflowUserAccessRight	Das Zugriffsrecht, das ein Benutzer für den Dataflow hat (Berechtigungsstufe)
displayName	string	Anzeigename des Prinzipals
emailAddress	string	E-Mail-Adresse des Benutzers
graphId	string	Bezeichner des Prinzipals in Microsoft Graph. Nur für Administrator-APIs verfügbar.
identifier	string	Bezeichner des Prinzipals
principalType	PrincipalType	Der Prinzipaltyp
profile	ServicePrincipalProfile	Ein Power BI-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Mehrinstanzenlösung.
userType	string	Typ des Benutzers.

DataflowUserAccessRight

Das Zugriffsrecht, das ein Benutzer für den Dataflow hat (Berechtigungsstufe)

Name	Typ	Beschreibung
None	string	Entfernt die Berechtigung für Inhalte im Dataflow.
Owner	string	Gewährt Lese-, Schreib- und erneuten Zugriff auf Inhalte im Dataflow
Read	string	Gewährt Lesezugriff auf Inhalte im Dataflow
ReadReshare	string	Gewährt Lese- und Erneuten Freigabezugriff auf Inhalte im Dataflow
ReadWrite	string	Gewährt Lese- und Schreibzugriff auf Inhalte im Dataflow

DatasetQueryScaleOutSettings

Abfragen von Horizontalskalierungseinstellungen eines Datasets

Name	Typ	Beschreibung
autoSyncReadOnlyReplicas	boolean	Gibt an, ob das Dataset schreibgeschützte Replikate automatisch synchronisiert.
maxReadOnlyReplicas	integer	Maximale Anzahl schreibgeschützter Replikate für das Dataset (0-64, -1 für die automatische Anzahl von Replikaten)

DatasetUser

Ein Power BI-Benutzerzugriffsrechteintrag für ein Dataset

Name	Typ	Beschreibung
datasetUserAccessRight	DatasetUserAccessRight	Das Zugriffsrecht, das der Benutzer für das Dataset hat (Berechtigungsstufe)
displayName	string	Anzeigename des Prinzipals
emailAddress	string	E-Mail-Adresse des Benutzers
graphId	string	Bezeichner des Prinzipals in Microsoft Graph. Nur für Administrator-APIs verfügbar.
identifier	string	Bezeichner des Prinzipals
principalType	PrincipalType	Der Prinzipaltyp
profile	ServicePrincipalProfile	Ein Power BI-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Mehrinstanzenlösung.
userType	string	Typ des Benutzers.

DatasetUserAccessRight

Das Zugriffsrecht, das der Benutzer für das Dataset hat (Berechtigungsstufe)

Name	Typ	Beschreibung
None	string	Entfernt die Berechtigung für den Inhalt im Dataset.
Read	string	Gewährt Lesezugriff auf den Inhalt im Dataset
ReadExplore	string	Gewährt Lese- und Erkundungszugriff auf den Inhalt im Dataset
ReadReshare	string	Gewährt Lese- und Erneuten Freigabezugriff auf den Inhalt im Dataset
ReadReshareExplore	string	Gewährt Lese-, Freigabe- und Erkundungszugriff auf den Inhalt im Dataset.
ReadWrite	string	Gewährt Lese- und Schreibzugriff auf den Inhalt im Dataset
ReadWriteExplore	string	Gewährt Lese-, Schreib- und Erkundungszugriff auf den Inhalt im Dataset.
ReadWriteReshare	string	Gewährt Lese-, Schreib- und freigabezugriff auf den Inhalt im Dataset
ReadWriteReshareExplore	string	Gewährt Lese-, Schreib-, Freigabe- und Erkundungszugriff auf den Inhalt im Dataset.

DefaultDatasetStorageFormat

Das Standarddatasetspeicherformat in der Gruppe

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

DependentDataflow

Ein abhängiger Power BI-Dataflow

Name	Typ	Beschreibung
groupId	string	Die Zielgruppen-ID
targetDataflowId	string	Die Ziel-Dataflow-ID

Encryption

Verschlüsselungsinformationen für ein Dataset

Name	Typ	Beschreibung
EncryptionStatus	EncryptionStatus	Datasetverschlüsselung status

EncryptionStatus

Datasetverschlüsselung status

Name	Typ	Beschreibung
InSyncWithWorkspace	string	Die Verschlüsselung wird unterstützt und wird mit den Verschlüsselungseinstellungen synchronisiert.
NotInSyncWithWorkspace	string	Die Verschlüsselung wird unterstützt, ist aber nicht mit den Verschlüsselungseinstellungen synchronisiert.
NotSupported	string	Die Verschlüsselung wird für dieses Dataset nicht unterstützt.
Unknown	string	Die Verschlüsselung status ist aufgrund einer Datasetbeschädigung unbekannt.

GroupType

Der Gruppentyp

Name	Typ	Beschreibung
Group	string	V1-Version des freigegebenen Arbeitsbereichs. Diese Art von Arbeitsbereichen ist veraltet, da Microsoft alle Arbeitsbereiche zur neuesten Version des freigegebenen Arbeitsbereichs migriert.
Personal	string	Spezieller Arbeitsbereichstyp für die SharePoint-Liste und OneDrive-Integration
PersonalGroup	string	"Mein Arbeitsbereich", auch als persönlicher Arbeitsbereich bezeichnet
Workspace	string	Freigegebener Arbeitsbereich oder einfacher Arbeitsbereich, der zum Freigeben von Inhalten für andere Benutzer im organization

GroupUser

Ein Power BI-Benutzer mit Zugriff auf den Arbeitsbereich

Name	Typ	Beschreibung
displayName	string	Anzeigename des Prinzipals
emailAddress	string	E-Mail-Adresse des Benutzers
graphId	string	Bezeichner des Prinzipals in Microsoft Graph. Nur für Administrator-APIs verfügbar.
groupUserAccessRight	GroupUserAccessRight	Das Zugriffsrecht (Berechtigungsstufe), das ein Benutzer im Arbeitsbereich hat
identifier	string	Bezeichner des Prinzipals
principalType	PrincipalType	Der Prinzipaltyp
profile	ServicePrincipalProfile	Ein Power BI-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Lösung mit mehreren Mandanten.
userType	string	Typ des Benutzers.

GroupUserAccessRight

Das Zugriffsrecht (Berechtigungsstufe), das ein Benutzer im Arbeitsbereich hat

Name	Typ	Beschreibung
Admin	string	Administratorrechte für Arbeitsbereichsinhalte
Contributor	string	Lesen und Erkunden des Zugriffs (ReadExplore) auf Arbeitsbereichsinhalte
Member	string	Lese-, Weiterfreigabe- und Sondierungsrechte (ReadReshareExplore) für Arbeitsbereichsinhalte
None	string	Kein Zugriff auf Arbeitsbereichsinhalte
Viewer	string	Schreibgeschützter Zugriff (Lesezugriff) auf Arbeitsbereichsinhalte

PrincipalType

Der Prinzipaltyp

Name	Typ	Beschreibung
App	string	Dienstprinzipaltyp
Group	string	Gruppenprinzipaltyp
None	string	Kein Prinzipaltyp. Verwenden Sie für den Zugriff auf organization ganzen Organization ebene.
User	string	Benutzerprinzipaltyp

ReportUser

Ein Power BI-Benutzerzugriffsrechteintrag für einen Bericht

Name	Typ	Beschreibung
displayName	string	Anzeigename des Prinzipals
emailAddress	string	E-Mail-Adresse des Benutzers
graphId	string	Bezeichner des Prinzipals in Microsoft Graph. Nur für Administrator-APIs verfügbar.
identifier	string	Bezeichner des Prinzipals
principalType	PrincipalType	Der Prinzipaltyp
profile	ServicePrincipalProfile	Ein Power BI-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Lösung mit mehreren Mandanten.
reportUserAccessRight	ReportUserAccessRight	Das Zugriffsrecht, das der Benutzer für den Bericht hat (Berechtigungsstufe)
userType	string	Typ des Benutzers.

ReportUserAccessRight

Das Zugriffsrecht, das der Benutzer für den Bericht hat (Berechtigungsstufe)

Name	Typ	Beschreibung
None	string	Keine Berechtigung für Inhalte im Bericht
Owner	string	Gewährt Lese-, Schreib- und erneuten Zugriff auf Inhalte im Bericht
Read	string	Gewährt Lesezugriff auf Inhalte im Bericht
ReadCopy	string	Gewährt Lese- und Kopierzugriff auf Inhalte im Bericht
ReadReshare	string	Gewährt lese- und erneuten Zugriff auf Inhalte im Bericht
ReadWrite	string	Gewährt Lese- und Schreibzugriff auf Inhalte im Bericht

ServicePrincipalProfile

Ein Power BI-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Lösung mit mehreren Mandanten.

Name	Typ	Beschreibung
displayName	string	Der Dienstprinzipalprofilname
id	string	Die Dienstprinzipalprofil-ID

Subscription

Ein E-Mail-Abonnement für ein Power BI-Element (z. B. einen Bericht oder eine Dashboard)

Name	Typ	Beschreibung
artifactDisplayName	string	Der Name des abonnierten Power BI-Elements (z. B. ein Bericht oder ein Dashboard)
artifactId	string	Die ID des abonnierten Power BI-Elements (z. B. ein Bericht oder ein Dashboard)
artifactType	string	Der Typ des Power BI-Elements (z. B. , `ReportDashboard`oder `Dataset`)
attachmentFormat	string	Format des Berichts, der im E-Mail-Abonnement angefügt ist
endDate	string	Enddatum und -uhrzeit des E-Mail-Abonnements
frequency	string	Häufigkeit des E-Mail-Abonnements
id	string	Die Abonnement-ID
isEnabled	boolean	Ob das E-Mail-Abonnement aktiviert ist
linkToContent	boolean	Ob ein Abonnementlink im E-Mail-Abonnement vorhanden ist
previewImage	boolean	Ob ein Screenshot des Berichts im E-Mail-Abonnement vorhanden ist
startDate	string	Startdatum und -uhrzeit des E-Mail-Abonnements
subArtifactDisplayName	string	Der Seitenname des abonnierten Power BI-Elements, wenn es sich um einen Bericht handelt.
title	string	Der App-Name
users	SubscriptionUser[]	Die Details der einzelnen E-Mail-Abonnenten. Wenn Sie den API-Aufruf "Benutzerabonnements abrufen als Admin" verwenden, ist der zurückgegebene Wert ein leeres Array (NULL). Diese Eigenschaft wird in einer bevorstehenden Version aus der Nutzlastantwort entfernt. Sie können Abonnementinformationen für einen Power BI-Bericht oder Dashboard abrufen, indem Sie die API-Aufrufe Berichtsabonnements abrufen als Admin oder Dashboardabonnements abrufen als Admin verwenden.

SubscriptionUser

Ein Power BI-E-Mail-Abonnementbenutzer

Name	Typ	Beschreibung
displayName	string	Anzeigename des Prinzipals
emailAddress	string	E-Mail-Adresse des Benutzers
graphId	string	Bezeichner des Prinzipals in Microsoft Graph. Nur für Administrator-APIs verfügbar.
identifier	string	Bezeichner des Prinzipals
principalType	PrincipalType	Der Prinzipaltyp
profile	ServicePrincipalProfile	Ein Power BI-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Mehrinstanzenlösung.
userType	string	Typ des Benutzers.

Workbook

Eine Power BI-Arbeitsmappe

Name	Typ	Beschreibung
datasetId	string	Die ID des Datasets, das einer Arbeitsmappe zugeordnet ist. Gilt nur, wenn die Arbeitsmappe über ein zugeordnetes Dataset verfügt.
name	string	Der Arbeitsmappenname

Admin - Groups GetGroupsAsAdmin

Berechtigungen

Erforderlicher Bereich

Einschränkungen

URI-Parameter

Antworten

Beispiele

Get deleted workspaces example.

Sample Request

Sample Response

Get orphaned workspaces example.

Sample Request

Sample Response

Get workspaces with their 'dashboards' expanded example

Sample Request

Sample Response

Get workspaces with their 'datasets' expanded example

Sample Request

Sample Response

Get workspaces with their 'datasets' expanded example.

Sample Request

Sample Response

Get workspaces with their 'reports' expanded example

Sample Request

Sample Response

Get workspaces with their 'users' expanded example.

Sample Request

Sample Response

Get workspaces with their 'workbooks' expanded example

Sample Request

Sample Response

Definitionen

AdminDashboard

AdminDataflow

AdminDataset

AdminGroup

AdminGroups

AdminReport

AdminTile

AzureResource

DashboardUser

DashboardUserAccessRight

DataflowUser

DataflowUserAccessRight

DatasetQueryScaleOutSettings

DatasetUser

DatasetUserAccessRight

DefaultDatasetStorageFormat

DependentDataflow

Encryption

EncryptionStatus

GroupType

GroupUser

GroupUserAccessRight

PrincipalType

ReportUser

ReportUserAccessRight

ServicePrincipalProfile

Subscription

SubscriptionUser

Workbook

Zusätzliche Ressourcen