Freigeben über

Admin - Reports GetReportSubscriptionsAsAdmin

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

Gibt eine Liste von Berichtsabonnements zusammen mit Abonnentendetails 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/reports/{reportId}/subscriptions

URI-Parameter

Name In Erforderlich Typ Beschreibung
reportId
 path True

string (uuid)

Die Berichts-ID

Antworten

Name Typ Beschreibung
200 OK

Subscriptions

OKAY

Beispiele

Example

Beispielanforderung

GET https://api.powerbi.com/v1.0/myorg/admin/reports/{reportId}/subscriptions

Beispiel für eine Antwort

Statuscode:
200 
{
  "value": [
    {
      "id": "18b746fe-c6d5-4a00-9523-05dc91424274",
      "title": "TestReportSubscription-1",
      "artifactId": "7b71b90a-a333-4006-b12c-ef3d767fa4e9",
      "artifactDisplayName": "Customer Profitability Sample",
      "subArtifactDisplayName": "Team Scorecard",
      "artifactType": "Report",
      "isEnabled": true,
      "frequency": "Daily",
      "startDate": "10/13/2021 12:00:00 AM",
      "endDate": "10/13/2022 12:00:00 AM",
      "linkToContent": true,
      "previewImage": true,
      "attachmentFormat": "PNG",
      "users": [
        {
          "displayName": "John Nick",
          "emailAddress": "john@contoso.com",
          "identifier": "john@contoso.com",
          "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
          "principalType": "User"
        }
      ]
    }
  ]
}

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)
Subscriptions

OData-Antwortwrapper für power BI-Abonnements
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.

Subscriptions

Objekt

OData-Antwortwrapper für power BI-Abonnements

Name Typ Beschreibung
@odata.context

string

value

Subscription[]

Power BI-E-Mail-Abonnement

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.