Admin - Users GetUserSubscriptionsAsAdmin

Service:

Power BI REST APIs

API Version:

v1.0

Gibt eine Liste von Abonnements für den angegebenen Benutzer zurück. Dies ist ein Vorschau-API-Aufruf.

Berechtigungen

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

Erforderlicher Bereich

Tenant.Read.All oder Tenant.ReadWrite.All

Einschränkungen

Maximal 200 Anforderungen pro Stunde.

GET https://api.powerbi.com/v1.0/myorg/admin/users/{userId}/subscriptions

With optional parameters:

GET https://api.powerbi.com/v1.0/myorg/admin/users/{userId}/subscriptions?continuationToken={continuationToken}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
userId	path	True	string	Die Graph-ID oder der Benutzerprinzipalname (UPN) des Benutzers
continuationToken	query		string	Token erforderlich, um den nächsten Abschnitt des Resultsets abzurufen

Antworten

Name	Typ	Beschreibung
200 OK	SubscriptionsByUserResponse	OK

Beispiele

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/users/f089354e-8366-4e18-aea3-4cb4a3a50b48/subscriptions

Sample Response

Status code:

200

{
  "subscriptionEntities": [
    {
      "id": "9225d0bc-9f5e-4819-a637-799c0c4fh3f1",
      "title": "Team Scorecard-test",
      "artifactId": "0b50f0bf-b22b-4685-83b9-b6d17f7f4e46",
      "artifactDisplayName": "Customer Profitability Sample",
      "subArtifactDisplayName": "Team Scorecard",
      "artifactType": "Report",
      "isEnabled": false,
      "frequency": "Daily",
      "startDate": "8/10/2021 12:00:00 AM",
      "endDate": "8/10/2022 12:00:00 AM",
      "linkToContent": false,
      "previewImage": true,
      "attachmentFormat": "PNG",
      "users": []
    }
  ],
  "continuationUri": "https://api.powerbi.com/v1.0/myorg/admin/users/f089354e-8366-4e18-aea3-4cb4a3a50b48/subscriptions?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

Definitionen

Name	Beschreibung
PrincipalType	Der Prinzipaltyp
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 ein Dashboard)
SubscriptionsByUserResponse	OData-Antwort wrapper für power BI-Abonnements für Benutzer
SubscriptionUser	Ein Power BI-E-Mail-Abonnementbenutzer

PrincipalType

Der Prinzipaltyp

Name	Typ	Beschreibung
App	string	Dienstprinzipaltyp
Group	string	Gruppenprinzipaltyp
None	string	Kein Prinzipaltyp. Verwenden Sie dies für den gesamten Zugriff auf Organisationsebene.
User	string	Benutzerprinzipaltyp

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 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	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 ein Power BI-Dashboard abrufen, indem Sie die API-Aufrufe Berichtsabonnements als Admin abrufen oder Dashboardabonnements abrufen als Admin verwenden.

SubscriptionsByUserResponse

OData-Antwort wrapper für power BI-Abonnements für Benutzer

Name	Typ	Beschreibung
continuationToken	string	Token zum Abrufen des nächsten Abschnitts des Resultsets
continuationUri	string	Der URI für den nächsten Abschnitt im Resultset
odata.context	string
subscriptionEntities	Subscription[]	Die Abonnements für Benutzer

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 Lösung mit mehreren Mandanten.
userType	string	Typ des Benutzers.