Admin - Dashboards GetDashboardSubscriptionsAsAdmin

Odwołanie

Service:: Power BI REST APIs

API Version:: v1.0

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

Uprawnienia

Użytkownik musi mieć uprawnienia administratora (takie jak administrator globalny Office 365 lub administrator usługi Power BI) lub uwierzytelnić się przy użyciu jednostki usługi.
Uprawnienia delegowane są obsługiwane.

Zakres wymagany

Tenant.Read.All lub Tenant.ReadWrite.All

Ograniczenia

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

GET https://api.powerbi.com/v1.0/myorg/admin/dashboards/{dashboardId}/subscriptions

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
dashboardId	path	True	string uuid	Identyfikator pulpitu nawigacyjnego

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Subscriptions	OK

Przykłady

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/dashboards/{dashboardId}/subscriptions

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "18b746fe-c6d5-4a00-9523-05dc91424275",
      "title": "TestDashboardSubscription-1",
      "artifactId": "7b71b90a-a333-4006-b12c-ef3d767fa4e9",
      "artifactDisplayName": "Customer Profitability Sample",
      "artifactType": "Dashboard",
      "isEnabled": true,
      "frequency": "Daily",
      "startDate": "10/13/2021 12:00:00 AM",
      "endDate": "10/13/2022 12:00:00 AM",
      "linkToContent": true,
      "previewImage": false,
      "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 główny usługa Power BI. Dotyczy tylko Power BI Embedded rozwiązania z wieloma dzierżawami.
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 e-mail usługi Power BI

PrincipalType

Typ podmiotu zabezpieczeń

Nazwa	Typ	Opis
App	string	Typ jednostki usługi
Group	string	Typ podmiotu zabezpieczeń grupy
None	string	Brak typu podmiotu zabezpieczeń. Służy do uzyskiwania dostępu na poziomie całej organizacji.
User	string	Typ podmiotu zabezpieczeń użytkownika

ServicePrincipalProfile

Profil główny usługa Power BI. Dotyczy tylko Power BI Embedded rozwiązania z wieloma dzierżawami.

Nazwa	Typ	Opis
displayName	string	Nazwa profilu jednostki usługi
id	string	Identyfikator profilu jednostki usługi

Subscription

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	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`, `Dashboard`lub `Dataset`)
attachmentFormat	string	Format raportu dołączonego do subskrypcji poczty e-mail
endDate	string	Data i godzina zakończenia subskrypcji e-mail
frequency	string	Częstotliwość subskrypcji poczty e-mail
id	string	Identyfikator subskrypcji
isEnabled	boolean	Czy subskrypcja poczty e-mail jest włączona
linkToContent	boolean	Czy link subskrypcji istnieje w subskrypcji e-mail
previewImage	boolean	Czy na zrzucie ekranu raportu istnieje subskrypcja poczty e-mail
startDate	string	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 każdego subskrybenta poczty e-mail. W przypadku używania wywołania interfejsu API Pobierz subskrypcje użytkowników jako Administracja 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 Administracja lub Pobierz subskrypcje pulpitu nawigacyjnego jako wywołania interfejsu API Administracja.

Subscriptions

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

Użytkownik subskrypcji 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 administratora.
identifier	string	Identyfikator podmiotu zabezpieczeń
principalType	PrincipalType	Typ podmiotu zabezpieczeń
profile	ServicePrincipalProfile	Profil główny usługa Power BI. Dotyczy tylko Power BI Embedded rozwiązania z wieloma dzierżawami.
userType	string	Typ użytkownika.

Share via