Freigeben über

Admin - Groups GetGroupsAsAdmin

  • Referenz
Dienst:
Power BI REST APIs
API-Version:
v1.0

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

Erlaubnisse

  • Der Benutzer muss ein Fabric-Administrator sein oder sich mit einem Dienstprinzipal authentifizieren.
  • Delegierte Berechtigungen werden unterstützt.

Wenn eine App unter der dienst prinicipalen Authentifizierung ausgeführt wird, darf eine App keine erforderlichen Administratorzustimmungen für Power BI im Azure-Portal festlegen.

Erforderlicher Bereich

Tenant.Read.All oder Tenant.ReadWrite.All

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

Begrenzungen

Maximal 50 Anforderungen pro Stunde oder 15 Anforderungen pro Minute, pro Mandant. Dieser Aufruf wird auch nach 30 Sekunden timeout, um negative Auswirkungen auf den Power BI-Dienst zu verhindern. 

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$top={$top}
Mit optionalen Parametern: 
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-5000 liegen.
$expand
 query

string

Akzeptiert eine durch Trennzeichen getrennte Liste von Datentypen, die inline in der Antwort erweitert wird. Unterstützt users, reports, dashboards, datasets, dataflowsund workbooks.
$filter
 query

string

Gibt eine Teilmenge einer Ergebnisse basierend auf Odata- Filterabfrageparameterbedingung zurück.
$skip
 query

integer

int32

Überspringt die ersten n Ergebnisse. Wird mit oben verwendet, um Ergebnisse über die ersten 5000 abzurufen.

Antworten

Name Typ Beschreibung
200 OK

AdminGroups

OKAY

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.

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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.

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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.

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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.

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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

Ein Power BI-Dashboard, das von Administrator-APIs zurückgegeben wird. Die API gibt eine Teilmenge der folgenden Liste der Dashboardeigenschaften zurück. Die Teilmenge hängt von der aufgerufenen API, den Aufruferberechtigungen und der Verfügbarkeit von Daten in der Power BI-Datenbank ab.
AdminDataflow

Die Metadaten eines von Administrator-APIs zurückgegebenen Datenflusses. Nachfolgend finden Sie eine Liste der Eigenschaften, die für einen Datenfluss zurückgegeben werden können. Je nach aufgerufener API, den Aufruferberechtigungen und der Verfügbarkeit der Daten in der Power BI-Datenbank werden nur eine Teilmenge der Eigenschaften zurückgegeben.
AdminDataset

Ein Power BI-Dataset, das von Administrator-APIs zurückgegeben wird. Die API gibt eine Teilmenge der folgenden Liste der Dataseteigenschaften zurück. Die Teilmenge hängt von der aufgerufenen API, 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-Antwortwrapper für eine Liste von Power BI-Gruppen, die von Administrator-APIs zurückgegeben werden
AdminReport

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

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

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

Ein Power BI-Benutzerzugriff für ein Dashboard
DashboardUserAccessRight

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

Ein Power BI-Benutzerzugriff für einen Datenfluss
DataflowUserAccessRight

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

Abfrageskalierungseinstellungen eines Datasets
DatasetUser

Ein Power BI-Benutzerzugriff für ein Dataset
DatasetUserAccessRight

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

Das Standardmäßige Datasetspeicherformat in der Gruppe
DependentDataflow

Ein abhängiger Power BI-Datenfluss
Encryption

Verschlüsselungsinformationen für ein Dataset
EncryptionStatus

Datensetverschlüsselungsstatus
GroupType

Der Gruppentyp
GroupUser

Ein Power BI-Benutzer mit Zugriff auf den Arbeitsbereich
GroupUserAccessRight

Das Zugriffsrecht (Berechtigungsstufe), über das ein Benutzer im Arbeitsbereich verfügt
PrincipalType

Der Prinzipaltyp
ReportUser

Ein Power BI-Benutzerzugriffsrecht für einen Bericht
ReportUserAccessRight

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

Ein Power BI-Dienstprinzipalprofil. Nur für Power BI Embedded Multi-Mandantenlösungrelevant.
Subscription

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

Ein Power BI-E-Mail-Abonnementbenutzer
Workbook

Eine Power BI-Arbeitsmappe

AdminDashboard

Ein Power BI-Dashboard, das von Administrator-APIs zurückgegeben wird. Die API gibt eine Teilmenge der folgenden Liste der Dashboardeigenschaften zurück. Die Teilmenge hängt von der aufgerufenen API, 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 das Dashboard zu einer App gehört
displayName

string

Der Anzeigename des Dashboards
embedUrl

string

Die Einbettungs-URL des Dashboards
id

string

Die Dashboard-ID
isReadOnly

boolean

Gibt an, ob das Dashboard schreibgeschützt ist.
subscriptions

Subscription[]

(Leerer Wert) Die Abonnementdetails für ein Power BI-Element (z. B. einen Bericht oder ein Dashboard). Diese Eigenschaft wird aus der Nutzlastantwort in einer bevorstehenden Version entfernt. Sie können Abonnementinformationen für einen Power BI-Bericht abrufen, indem Sie den Abrufen von Berichtsabonnements als Administrator- API-Aufruf verwenden.
tiles

AdminTile[]

Die Kacheln, die zum Dashboard gehören
users

DashboardUser[]

(Leerer Wert) Details des Dashboardbenutzerzugriffs. Diese Eigenschaft wird aus der Nutzlastantwort in einer bevorstehenden Version entfernt. Sie können Benutzerinformationen auf einem Power BI-Dashboard abrufen, indem Sie den Abrufen von Dashboardbenutzern als Administrator- API-Aufruf oder den PostWorkspaceInfo-API-Aufruf mit dem parameter getArtifactUsers verwenden.
webUrl

string

Die Web-URL des Dashboards
workspaceId

string

Die Arbeitsbereichs-ID (GUID) des Dashboards. Diese Eigenschaft wird nur in GetDashboardsAsAdmin zurückgegeben.

AdminDataflow

Die Metadaten eines von Administrator-APIs zurückgegebenen Datenflusses. Nachfolgend finden Sie eine Liste der Eigenschaften, die für einen Datenfluss zurückgegeben werden können. Je nach aufgerufener API, den Aufruferberechtigungen und der Verfügbarkeit der Daten in der Power BI-Datenbank werden nur eine Teilmenge der Eigenschaften zurückgegeben.

Name Typ Beschreibung
configuredBy

string

Der Datenflussbesitzer
description

string

Die Beschreibung des Datenflusses
modelUrl

string

Eine URL zur Datenflussdefinitionsdatei (model.json)
name

string

Der Name des Datenflusses
objectId

string

Die Datenfluss-ID
users

DataflowUser[]

(Leerer Wert) Die Datenflussbenutzerzugriffsdetails. Diese Eigenschaft wird aus der Nutzlastantwort in einer bevorstehenden Version entfernt. Sie können Benutzerinformationen für einen Power BI-Datenfluss abrufen, indem Sie den Get Dataflow Users as Admin API-Aufruf oder den PostWorkspaceInfo API-Aufruf mit dem parameter getArtifactUser verwenden.
workspaceId

string

Die Datenflussarbeitsbereichs-ID.

AdminDataset

Ein Power BI-Dataset, das von Administrator-APIs zurückgegeben wird. Die API gibt eine Teilmenge der folgenden Liste der Dataseteigenschaften zurück. Die Teilmenge hängt von der aufgerufenen API, 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

Die Datensatz erstellen Berichtseinbettungs-URL
Encryption

Encryption

Datensetverschlü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 innerhalb der Power BI-PBIX-Datei definiert ist. Wenn ja, müssen Sie eine Rolle angeben.
IsInPlaceSharingEnabled

boolean

Gibt an, ob das Dataset für externe Benutzer freigegeben werden kann, die in ihrem eigenen Mandanten genutzt werden sollen.
IsOnPremGatewayRequired

boolean

Gibt an, ob für das Dataset ein lokales Datengateway erforderlich ist.
IsRefreshable

boolean

Dieses Feld gibt true zurück, wenn das Dataset kürzlich aktualisiert oder für die automatische Aktualisierung konfiguriert ist, wobei der Verbindungsmodus speziell auf "Import" festgelegt ist. Der Wert gibt false für andere Verbindungsmodi zurück, z. B. "DirectQuery" und "LiveConnection", unabhängig davon, ob das Dataset manuell aktualisiert oder für die automatische Aktualisierung eingerichtet wird.
QnaEmbedURL

string

Das Dataset Q&Eine Einbettungs-URL
addRowsAPIEnabled

boolean

Gibt an, ob das Dataset das Hinzufügen neuer Zeilen zulässt.
configuredBy

string

Der Datasetbesitzer
createdDate

string

Datum und Uhrzeit der Datensatzerstellung
description

string

Beschreibung des Datasets
id

string

Die Dataset-ID
name

string

Der Datasetname
queryScaleOutSettings

DatasetQueryScaleOutSettings

Abfrageskalierungseinstellungen eines Datasets
targetStorageMode

string

Der Datasetspeichermodus
upstreamDataflows

DependentDataflow[]

Die Liste aller Datenflüsse dieses Elements hängt von
users

DatasetUser[]

(Leerer Wert) Die Details des Datasetbenutzerzugriffs. Diese Eigenschaft wird aus der Nutzlastantwort in einer bevorstehenden Version 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 Arbeitsbereichs-ID des Datasets. 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 Power BI-Speicherkonto-ID
dataflows

AdminDataflow[]

Die Datenflüsse, die zur Gruppe gehören
datasets

AdminDataset[]

Die Datasets, die zur Gruppe gehören
defaultDatasetStorageFormat

DefaultDatasetStorageFormat

Das Standardspeicherformat des Datasets im Arbeitsbereich. Wird nur zurückgegeben, wenn isOnDedicatedCapacitytrue
description

string

Die Gruppenbeschreibung
hasWorkspaceLevelSettings

boolean

Gibt an, ob der Arbeitsbereich über benutzerdefinierte Einstellungen verfügt.
id

string

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
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 deren Zugriffsrechte. Diese Eigenschaft wird aus der Nutzlastantwort in einer bevorstehenden Version entfernt. Sie können Benutzerinformationen zu einem Power BI-Element (z. B. einem Bericht oder einem Dashboard) abrufen, indem Sie die "Gruppenbenutzer als Administrator abrufen" API-Aufruf oder den PostWorkspaceInfo API-Aufruf mit dem parameter getArtifactUsers verwenden.
workbooks

Workbook[]

Die Arbeitsmappen, die zur Gruppe gehören

AdminGroups

Der OData-Antwortwrapper für eine Liste von Power BI-Gruppen, die von Administrator-APIs zurückgegeben werden

Name Typ Beschreibung
@odata.context

string

OData-Kontext
value

AdminGroup[]

Die Liste der Gruppen

AdminReport

Ein Von Administrator-APIs zurückgegebener Power BI-Bericht. Die API gibt eine Teilmenge der folgenden Liste der Berichtseigenschaften zurück. Die Teilmenge hängt von der aufgerufenen API, 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 ein Dashboard). Diese Eigenschaft wird aus der Nutzlastantwort in einer bevorstehenden Version entfernt. Sie können Abonnementinformationen für einen Power BI-Bericht abrufen, indem Sie den Abrufen von Berichtsabonnements als Administrator- API-Aufruf verwenden.
users

ReportUser[]

(Leerer Wert) Der Benutzer greift auf Details für einen Power BI-Bericht zu. Diese Eigenschaft wird aus der Nutzlastantwort in einer bevorstehenden Version entfernt. Sie können Benutzerinformationen in einem Power BI-Bericht abrufen, indem Sie die Abrufen von Berichtsbenutzern als Administrator- API-Aufruf oder den PostWorkspaceInfo API-Aufruf mit dem parameter getArtifactUsers 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 Administrator-APIs zurückgegeben wird.

Name Typ Beschreibung
colSpan

integer

Die Anzahl der Kachelbereichsspalten
datasetId

string

Die Dataset-ID. Nur für Kacheln verfügbar, 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 Kachelbereichszeilen
title

string

Der Anzeigename der Kachel

AzureResource

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

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-Benutzerzugriff für ein Dashboard

Name Typ Beschreibung
dashboardUserAccessRight

DashboardUserAccessRight

Das Zugriffsrecht, das der Benutzer für das 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-Dienstprinzipalprofil. Nur für Power BI Embedded Multi-Mandantenlösungrelevant.
userType

string

Typ des Benutzers.

DashboardUserAccessRight

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

Name Typ Beschreibung
None

string

Keine Berechtigung für Inhalte im Dashboard
Owner

string

Gewährt Lese-, Schreib- und Freigabezugriff auf Inhalte im Bericht
Read

string

Gewährt Lesezugriff auf Inhalte im Dashboard
ReadCopy

string

Gewährt Lese- und Kopierzugriff auf Inhalte im Dashboard
ReadReshare

string

Gewährt Lese- und Freigabezugriff auf Inhalte im Dashboard
ReadWrite

string

Gewährt Lese- und Schreibzugriff auf Inhalte im Dashboard

DataflowUser

Ein Power BI-Benutzerzugriff für einen Datenfluss

Name Typ Beschreibung
DataflowUserAccessRight

DataflowUserAccessRight

Das Zugriffsrecht, das ein Benutzer für den Datenfluss 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-Dienstprinzipalprofil. Nur für Power BI Embedded Multi-Mandantenlösungrelevant.
userType

string

Typ des Benutzers.

DataflowUserAccessRight

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

Name Typ Beschreibung
None

string

Entfernt die Berechtigung für Inhalte im Datenfluss.
Owner

string

Gewährt Lese-, Schreib- und Freigabezugriff auf Inhalte im Datenfluss
Read

string

Gewährt Lesezugriff auf Inhalte im Datenfluss
ReadReshare

string

Gewährt Lese- und Freigabezugriff auf Inhalte im Datenfluss
ReadWrite

string

Gewährt Lese- und Schreibzugriff auf Inhalte im Datenfluss

DatasetQueryScaleOutSettings

Abfrageskalierungseinstellungen 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-Benutzerzugriff 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-Dienstprinzipalprofil. Nur für Power BI Embedded Multi-Mandantenlösungrelevant.
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 Freigabezugriff auf den Inhalt im Dataset
ReadReshareExplore

string

Gewährt Lese-, Freigabe- und Erkunden des Zugriffs auf den Inhalt im Dataset
ReadWrite

string

Gewährt Lese- und Schreibzugriff auf den Inhalt im Dataset
ReadWriteExplore

string

Gewährt Lese-, Schreib- und Erkunden des Zugriffs auf den Inhalt im Dataset
ReadWriteReshare

string

Gewährt Lese-, Schreib- und Freigabezugriff auf den Inhalt im Dataset
ReadWriteReshareExplore

string

Gewährt Lese-, Schreib-, Refreigabe- und Erkunden des Zugriffs auf den Inhalt im Dataset

DefaultDatasetStorageFormat

Das Standardmäßige Datasetspeicherformat in der Gruppe

Name Typ Beschreibung
Large

string

Großes Dataset-Speicherformat
Small

string

Kleines Dataset-Speicherformat

DependentDataflow

Ein abhängiger Power BI-Datenfluss

Name Typ Beschreibung
groupId

string

Die Zielgruppen-ID
targetDataflowId

string

Die Zieldatenfluss-ID

Encryption

Verschlüsselungsinformationen für ein Dataset

Name Typ Beschreibung
EncryptionStatus

EncryptionStatus

Datensetverschlüsselungsstatus

EncryptionStatus

Datensetverschlüsselungsstatus

Name Typ Beschreibung
InSyncWithWorkspace

string

Die Verschlüsselung wird unterstützt und wird mit den Verschlüsselungseinstellungen synchronisiert.
NotInSyncWithWorkspace

string

Verschlüsselung wird unterstützt, aber nicht mit den Verschlüsselungseinstellungen synchronisiert
NotSupported

string

Die Verschlüsselung wird für dieses Dataset nicht unterstützt.
Unknown

string

Der Verschlüsselungsstatus ist aufgrund von Datasetbeschädigungen unbekannt.

GroupType

Der Gruppentyp

Name Typ Beschreibung
AdminWorkspace

string

Administratorüberwachung für Fabric-Administratoren
Group

string

V1-Version des freigegebenen Arbeitsbereichs. Diese Art von Arbeitsbereichen ist veraltet, da Microsoft alle Arbeitsbereiche auf die neueste Version des freigegebenen Arbeitsbereichs migriert.
Personal

string

Spezieller Arbeitsbereichstyp, der für die SharePoint-Liste und die OneDrive-Integration vorgesehen ist
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 in der Organisation verwendet wird

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), über das ein Benutzer im Arbeitsbereich verfügt
identifier

string

Bezeichner des Prinzipals
principalType

PrincipalType

Der Prinzipaltyp
profile

ServicePrincipalProfile

Ein Power BI-Dienstprinzipalprofil. Nur für Power BI Embedded Multi-Mandantenlösungrelevant.
userType

string

Typ des Benutzers.

GroupUserAccessRight

Das Zugriffsrecht (Berechtigungsstufe), über das ein Benutzer im Arbeitsbereich verfügt

Name Typ Beschreibung
Admin

string

Administratorrechte für Arbeitsbereichsinhalte
Contributor

string

Lese- und Erkundungszugriff (ReadExplore) auf Arbeitsbereichsinhalte
Member

string

Lese-, Freigabe- und Erkundungsrechte (ReadReshareExplore) für Arbeitsbereichsinhalte
None

string

Kein Zugriff auf Arbeitsbereichsinhalte
Viewer

string

Schreibgeschützter (Lesezugriff) auf Arbeitsbereichsinhalte

PrincipalType

Der Prinzipaltyp

Name Typ Beschreibung
App

string

Dienstprinzipaltyp
Group

string

Gruppenprinzipaltyp
None

string

Kein Prinzipaltyp. Wird für den Zugriff auf ganze Organisationsebene verwendet.
User

string

Benutzerprinzipaltyp

ReportUser

Ein Power BI-Benutzerzugriffsrecht 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-Dienstprinzipalprofil. Nur für Power BI Embedded Multi-Mandantenlösungrelevant.
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 Freigabezugriff 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 Freigabezugriff auf Inhalte im Bericht
ReadWrite

string

Gewährt Lese- und Schreibzugriff auf Inhalte im Bericht

ServicePrincipalProfile

Ein Power BI-Dienstprinzipalprofil. Nur für Power BI Embedded Multi-Mandantenlösungrelevant.

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 ein 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. ein Report, Dashboardoder 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

Die Häufigkeit des E-Mail-Abonnements
id

string

Die Abonnement-ID
isEnabled

boolean

Gibt an, ob das E-Mail-Abonnement aktiviert ist.
linkToContent

boolean

Gibt an, ob ein Abonnementlink im E-Mail-Abonnement vorhanden ist.
previewImage

boolean

Gibt an, 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. Bei Verwendung des Abrufen von Benutzerabonnements als Administrator API-Aufruf ist der zurückgegebene Wert ein leeres Array (NULL). Diese Eigenschaft wird aus der Nutzlastantwort in einer bevorstehenden Version entfernt. Sie können Abonnementinformationen in einem Power BI-Bericht oder -Dashboard abrufen, indem Sie die Abrufen von Berichtsabonnements als Administrator- oder Abrufen von Dashboardabonnements als Administrator API-Aufrufen 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-Dienstprinzipalprofil. Nur für Power BI Embedded Multi-Mandantenlösungrelevant.
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 Name der Arbeitsmappe