Udostępnij przez

Admin - Reports GetReportSubscriptionsAsAdmin

Usługa:
Power BI REST APIs
Wersja interfejsu API:
v1.0

Zwraca listę subskrypcji raportów wraz ze szczegółami subskrybenta. Jest to wywołanie interfejsu API w wersji zapoznawczej.

Permissions

  • Użytkownik musi być administratorem sieci szkieletowej lub uwierzytelniać się przy użyciu jednostki usługi.
  • Uprawnienia delegowane są obsługiwane.

Wymagany zakres

Tenant.Read.All lub Tenant.ReadWrite.All

Ograniczenia

Maksymalna liczba żądań na godzinę wynosi 200. 

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
reportId
 path True

string (uuid)

Identyfikator raportu

Odpowiedzi

Nazwa Typ Opis
200 OK

Subscriptions

OK

Przykłady

Example

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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"
        }
      ]
    }
  ]
}

Definicje

Nazwa Opis
PrincipalType

Typ podmiotu zabezpieczeń
ServicePrincipalProfile

Profil jednostki usługi Power BI. Dotyczy tylko rozwiązania z wieloma dzierżawami usługi Power BI Embedded.
Subscription

Subskrypcja poczty e-mail dla elementu usługi Power BI (na przykład raportu lub pulpitu nawigacyjnego)
Subscriptions

Otoka odpowiedzi OData dla subskrypcji usługi Power BI
SubscriptionUser

Użytkownik subskrypcji poczty e-mail usługi Power BI

PrincipalType

Wyliczanie

Typ podmiotu zabezpieczeń

Wartość Opis
None

Brak typu podmiotu zabezpieczeń. Służy do uzyskiwania dostępu na poziomie całej organizacji.
User

Typ podmiotu zabezpieczeń użytkownika
Group

Typ podmiotu zabezpieczeń grupy
App

Typ jednostki usługi

ServicePrincipalProfile

Objekt

Profil jednostki usługi Power BI. Dotyczy tylko rozwiązania z wieloma dzierżawami usługi Power BI Embedded.

Nazwa Typ Opis
displayName

string

Nazwa profilu jednostki usługi
id

string (uuid)

Identyfikator profilu jednostki usługi

Subscription

Objekt

Subskrypcja poczty e-mail dla elementu usługi Power BI (na przykład raportu lub pulpitu nawigacyjnego)

Nazwa Typ Opis
artifactDisplayName

string

Nazwa subskrybowanego elementu usługi Power BI (na przykład raportu lub pulpitu nawigacyjnego)
artifactId

string (uuid)

Identyfikator subskrybowanego elementu usługi Power BI (na przykład raportu lub pulpitu nawigacyjnego)
artifactType

string

Typ elementu usługi Power BI (na przykład Report, Dashboardlub Dataset)
attachmentFormat

string

Format raportu dołączonego do subskrypcji poczty e-mail
endDate

string (date-time)

Data i godzina zakończenia subskrypcji poczty e-mail
frequency

string

Częstotliwość subskrypcji poczty e-mail
id

string (uuid)

Identyfikator subskrypcji
isEnabled

boolean

Czy subskrypcja poczty e-mail jest włączona
linkToContent

boolean

Czy link subskrypcji istnieje w subskrypcji poczty e-mail
previewImage

boolean

Czy zrzut ekranu raportu istnieje w subskrypcji poczty e-mail
startDate

string (date-time)

Data i godzina rozpoczęcia subskrypcji poczty e-mail
subArtifactDisplayName

string

Nazwa strony subskrybowanego elementu usługi Power BI, jeśli jest to raport.
title

string

Nazwa aplikacji
users

SubscriptionUser[]

Szczegóły poszczególnych subskrybentów poczty e-mail. W przypadku używania wywołania interfejsu API pobierania subskrypcji użytkowników jako administratora zwracana wartość jest pustą tablicą (null). Ta właściwość zostanie usunięta z odpowiedzi ładunku w nadchodzącej wersji. Informacje o subskrypcji w raporcie lub pulpicie nawigacyjnym usługi Power BI można pobrać przy użyciu opcji Pobierz subskrypcje raportów jako administrator lub Pobierz subskrypcje pulpitu nawigacyjnego jako wywołania interfejsu API administratora .

Subscriptions

Objekt

Otoka odpowiedzi OData dla subskrypcji usługi Power BI

Nazwa Typ Opis
@odata.context

string

value

Subscription[]

Subskrypcja poczty e-mail usługi Power BI

SubscriptionUser

Objekt

Użytkownik subskrypcji poczty e-mail usługi Power BI

Nazwa Typ Opis
displayName

string

Nazwa wyświetlana podmiotu zabezpieczeń
emailAddress

string

Adres e-mail użytkownika
graphId

string

Identyfikator podmiotu zabezpieczeń w programie Microsoft Graph. Dostępne tylko dla interfejsów API administratorów.
identifier

string

Identyfikator podmiotu zabezpieczeń
principalType

PrincipalType

Typ podmiotu zabezpieczeń
profile

ServicePrincipalProfile

Profil jednostki usługi Power BI. Dotyczy tylko rozwiązania z wieloma dzierżawami usługi Power BI Embedded.
userType

string

Typ użytkownika.