Freigeben über


Admin - Dashboards GetDashboardsAsAdmin

Gibt eine Liste der Dashboards 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.

Bei der Ausführung unter der dienst prinicipalen Authentifizierung darf eine App keine erforderlichen Administratorzustimmungen für Power BI im Azure-Portal haben.

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.

Einschränkungen

Maximal 50 Anforderungen pro Stunde oder 5 Anforderungen pro Minute, pro Mandant.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
$expand
query

string

Akzeptiert eine durch Trennzeichen getrennte Liste von Datentypen, die inline in der Antwort erweitert wird. Unterstützt tiles.

$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

AdminDashboards

OKAY

Beispiele

Example

Beispielanforderung

GET https://api.powerbi.com/v1.0/myorg/admin/dashboards

Beispiel für eine Antwort

{
  "value": [
    {
      "id": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
      "displayName": "SalesMarketing",
      "embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
      "isReadOnly": false,
      "workspaceId": "abfbdc89-2659-43c1-9142-93e8378eac96"
    }
  ]
}

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.

AdminDashboards

Der OData-Antwortwrapper für eine Power BI-Dashboardsammlung

AdminTile

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

DashboardUser

Ein Power BI-Benutzerzugriff für ein Dashboard

DashboardUserAccessRight

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

PrincipalType

Der Prinzipaltyp

ServicePrincipalProfile

Ein Power BI-Dienstprinzipalprofil. Nur für Power BI Embedded Mandantenlösung relevant.

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

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 (uuid)

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 Administrator-API-Aufruf zum Abrufen von Berichtsabonnements 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 Api-Aufruf "Dashboardbenutzer abrufen" oder den PostWorkspaceInfo-API-Aufruf mit dem getArtifactUsers Parameter verwenden.

webUrl

string

Die Web-URL des Dashboards

workspaceId

string (uuid)

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

AdminDashboards

Der OData-Antwortwrapper für eine Power BI-Dashboardsammlung

Name Typ Beschreibung
@odata.context

string

OData-Kontext

value

AdminDashboard[]

Die Dashboardsammlung

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. F&A-Kacheln.

embedData

string

Die Einbettungsdaten für die Kachel

embedUrl

string

Die Einbettungs-URL der Kachel

id

string (uuid)

Die Kachel-ID

reportId

string (uuid)

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

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 Mandantenlösung relevant.

userType

string

Typ des Benutzers.

DashboardUserAccessRight

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

Wert Beschreibung
None

Keine Berechtigung für Inhalte im Dashboard

Read

Gewährt Lesezugriff auf Inhalte im Dashboard

ReadWrite

Gewährt Lese- und Schreibzugriff auf Inhalte im Dashboard

ReadReshare

Gewährt Lese- und Freigabezugriff auf Inhalte im Dashboard

ReadCopy

Gewährt Lese- und Kopierzugriff auf Inhalte im Dashboard

Owner

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

PrincipalType

Der Prinzipaltyp

Wert Beschreibung
None

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

User

Benutzerprinzipaltyp

Group

Gruppenprinzipaltyp

App

Dienstprinzipaltyp

ServicePrincipalProfile

Ein Power BI-Dienstprinzipalprofil. Nur für Power BI Embedded Mandantenlösung relevant.

Name Typ Beschreibung
displayName

string

Der Dienstprinzipalprofilname

id

string (uuid)

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 (uuid)

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 (date-time)

Enddatum und -uhrzeit des E-Mail-Abonnements

frequency

string

Die Häufigkeit des E-Mail-Abonnements

id

string (uuid)

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 (date-time)

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 Aufrufs " Benutzerabonnements als Administrator-API abrufen" 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 Dashboardabonnements als Administrator-API-Aufrufe 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 Mandantenlösung relevant.

userType

string

Typ des Benutzers.