Admin - Dashboards GetDashboardsInGroupAsAdmin
Gibt eine Liste von Dashboards aus dem angegebenen Arbeitsbereich 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 200 Anforderungen pro Stunde.
GET https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/dashboards
GET https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/dashboards?$filter={$filter}&$top={$top}&$skip={$skip}
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
group
|
path | True |
string uuid |
Arbeitsbereich-ID |
$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 |
OK |
Beispiele
Example
Sample Request
GET https://api.powerbi.com/v1.0/myorg/admin/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dashboards
Sample Response
{
"value": [
{
"id": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
"displayName": "SalesMarketing",
"embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af&groupId=f089354e-8366-4e18-aea3-4cb4a3a50b48",
"isReadOnly": false
}
]
}
Definitionen
Name | Beschreibung |
---|---|
Admin |
Eine Power BI-Dashboard, die von Admin-APIs zurückgegeben wird. Die API gibt eine Teilmenge der folgenden Liste von Dashboard Eigenschaften zurück. Die Teilmenge hängt von der aufgerufenen API, den Aufruferberechtigungen und der Verfügbarkeit von Daten in der Power BI-Datenbank ab. |
Admin |
OData-Antwortwrapper für eine Power BI-Dashboard sammlung |
Admin |
Eine von Admin APIs zurückgegebene Power BI-Kachel. |
Dashboard |
Ein Power BI-Benutzerzugriffsrechteintrag für eine Dashboard |
Dashboard |
Das Zugriffsrecht, das der Benutzer für die Dashboard hat (Berechtigungsstufe) |
Principal |
Der Prinzipaltyp |
Service |
Ein Power BI-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Mehrinstanzenlösung. |
Subscription |
Ein E-Mail-Abonnement für ein Power BI-Element (z. B. einen Bericht oder eine Dashboard) |
Subscription |
Ein Power BI-E-Mail-Abonnementbenutzer |
AdminDashboard
Eine Power BI-Dashboard, die von Admin-APIs zurückgegeben wird. Die API gibt eine Teilmenge der folgenden Liste von Dashboard Eigenschaften 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 die Dashboard zu einer App gehört. |
displayName |
string |
Der Anzeigename des Dashboard |
embedUrl |
string |
Die Einbettungs-URL der Dashboard |
id |
string |
Die Dashboard-ID |
isReadOnly |
boolean |
Gibt an, ob die Dashboard schreibgeschützt ist. |
subscriptions |
(Leerer Wert) Die Abonnementdetails für ein Power BI-Element (z. B. einen Bericht oder eine Dashboard). Diese Eigenschaft wird in einem bevorstehenden Release aus der Nutzlastantwort entfernt. Sie können Abonnementinformationen für einen Power BI-Bericht abrufen, indem Sie den API-Aufruf Zum Abrufen von Berichtsabonnements als Admin verwenden. |
|
tiles |
Die Kacheln, die zum Dashboard gehören |
|
users |
(Leerer Wert) Die Dashboard Benutzerzugriffsdetails. Diese Eigenschaft wird in einem bevorstehenden Release aus der Nutzlastantwort entfernt. Sie können Benutzerinformationen zu einem Power BI-Dashboard abrufen, indem Sie den Aufruf Dashboardbenutzer als Admin API abrufen oder den Api-Aufruf PostWorkspaceInfo mit dem |
|
webUrl |
string |
Die Web-URL der Dashboard |
workspaceId |
string |
Die Arbeitsbereichs-ID (GUID) des Dashboard. Diese Eigenschaft wird nur in GetDashboardsAsAdmin zurückgegeben. |
AdminDashboards
OData-Antwortwrapper für eine Power BI-Dashboard sammlung
Name | Typ | Beschreibung |
---|---|---|
odata.context |
string |
OData-Kontext |
value |
Die Dashboard-Auflistung |
AdminTile
Eine von Admin APIs zurückgegebene Power BI-Kachel.
Name | Typ | Beschreibung |
---|---|---|
colSpan |
integer |
Die Anzahl der Kachelspannenspalten |
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 Kachelspannzeilen |
title |
string |
Der Anzeigename der Kachel |
DashboardUser
Ein Power BI-Benutzerzugriffsrechteintrag für eine Dashboard
Name | Typ | Beschreibung |
---|---|---|
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 |
Der Prinzipaltyp |
|
profile |
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 |
PrincipalType
Der Prinzipaltyp
Name | Typ | Beschreibung |
---|---|---|
App |
string |
Dienstprinzipaltyp |
Group |
string |
Gruppenprinzipaltyp |
None |
string |
Kein Prinzipaltyp. Verwenden Sie für den Zugriff auf die gesamte organization ebene. |
User |
string |
Benutzerprinzipaltyp |
ServicePrincipalProfile
Ein Power BI-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Mehrinstanzenlösung.
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. , |
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 |
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 |
Die Details jedes E-Mail-Abonnenten. Wenn Sie den API-Aufruf Get User Subscriptions As Admin verwenden, ist der zurückgegebene Wert ein leeres Array (NULL). Diese Eigenschaft wird in einem bevorstehenden Release aus der Nutzlastantwort entfernt. Sie können Abonnementinformationen zu einem Power BI-Bericht oder Dashboard abrufen, indem Sie die API-Aufrufe "Berichtsabonnements als Admin abrufen" oder "Dashboardabonnements als Admin abrufen" 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 |
Der Prinzipaltyp |
|
profile |
Ein Power BI-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Mehrinstanzenlösung. |
|
userType |
string |
Typ des Benutzers. |