Freigeben über

Admin - Users GetUserSubscriptionsAsAdmin

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

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

Erlaubnisse

  • Der Benutzer muss ein Fabric-Administrator sein 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
Mit optionalen Parametern: 
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 Teil des Resultsets abzurufen

Antworten

Name Typ Beschreibung
200 OK

SubscriptionsByUserResponse

OKAY

Beispiele

Example

Beispielanforderung

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

Beispiel für eine Antwort

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

OData-Antwortwrapper für ein Power BI-Abonnement für Benutzer
SubscriptionUser

Ein Power BI-E-Mail-Abonnementbenutzer

PrincipalType

Enumeration

Der Prinzipaltyp

Wert Beschreibung
None

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

Benutzerprinzipaltyp
Group

Gruppenprinzipaltyp
App

Dienstprinzipaltyp

ServicePrincipalProfile

Objekt

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

Objekt

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.

SubscriptionsByUserResponse

Objekt

OData-Antwortwrapper für ein Power BI-Abonnement für Benutzer

Name Typ Beschreibung
@odata.context

string

continuationToken

string

Token zum Abrufen des nächsten Abschnitts des Resultsets
continuationUri

string

Der URI für den nächsten Block im Resultset
subscriptionEntities

Subscription[]

Die Abonnements für den Benutzer

SubscriptionUser

Objekt

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.