Admin - Dashboards GetDashboardSubscriptionsAsAdmin

Service:

Power BI REST APIs

API Version:

v1.0

Vrátí seznam odběrů řídicího panelu spolu s podrobnostmi o odběrateli. Toto je volání rozhraní API verze Preview.

Oprávnění

• Uživatel musí mít oprávnění správce (například Office 365 globálního správce nebo správce služby Power BI) nebo ověřování pomocí instančního objektu.
• Delegovaná oprávnění jsou podporovaná.

Požadovaný obor

Tenant.Read.All nebo Tenant.ReadWrite.All

Omezení

Maximálně 200 požadavků za hodinu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
dashboardId	path	True	string uuid	ID řídicího panelu

Odpovědi

Name	Typ	Description
200 OK	Subscriptions	OK

Příklady

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"
        }
      ]
    }
  ]
}

Definice

Name	Description
PrincipalType	Typ objektu zabezpečení
ServicePrincipalProfile	Profil objektu zabezpečení služba Power BI. Relevantní pouze pro Power BI Embedded řešení s více tenanty.
Subscription	Odběr e-mailu pro položku Power BI (například sestavu nebo řídicí panel)
Subscriptions	Obálka odpovědí OData pro předplatná Power BI
SubscriptionUser	Uživatel e-mailového předplatného Power BI

PrincipalType

Typ objektu zabezpečení

Name	Typ	Description
App	string	Typ instančního objektu
Group	string	Typ objektu zabezpečení skupiny
None	string	Žádný typ objektu zabezpečení. Používá se pro přístup na úrovni celé organizace.
User	string	Typ objektu zabezpečení uživatele

ServicePrincipalProfile

Profil objektu zabezpečení služba Power BI. Relevantní pouze pro Power BI Embedded řešení s více tenanty.

Name	Typ	Description
displayName	string	Název profilu instančního objektu
id	string	ID profilu instančního objektu

Subscription

Odběr e-mailu pro položku Power BI (například sestavu nebo řídicí panel)

Name	Typ	Description
artifactDisplayName	string	Název odebírané položky Power BI (například sestavy nebo řídicího panelu)
artifactId	string	ID odebírané položky Power BI (například sestavy nebo řídicího panelu)
artifactType	string	Typ položky Power BI (například Report, Dashboardnebo Dataset)
attachmentFormat	string	Formát sestavy připojené k odběru e-mailu
endDate	string	Koncové datum a čas odběru e-mailu
frequency	string	Frekvence odběru e-mailu
id	string	ID předplatného
isEnabled	boolean	Jestli je povolené předplatné e-mailu
linkToContent	boolean	Jestli v e-mailovém předplatném existuje odkaz na předplatné
previewImage	boolean	Jestli v odběru e-mailu existuje snímek obrazovky se sestavou
startDate	string	Počáteční datum a čas odběru e-mailu
subArtifactDisplayName	string	Název stránky odebírané položky Power BI, pokud se jedná o sestavu.
title	string	Název aplikace
users	SubscriptionUser[]	Podrobnosti o každém odběrateli e-mailu. Při použití volání rozhraní API Get User Subscriptions As Správa je vrácená hodnota prázdné pole (null). Tato vlastnost bude odebrána z odpovědi datové části v nadcházející verzi. Informace o předplatném sestavy nebo řídicího panelu Power BI můžete načíst pomocí volání rozhraní API Získat odběry sestav jako Správa nebo Získat odběry řídicích panelů jako Správa.

Subscriptions

Obálka odpovědí OData pro předplatná Power BI

Name	Typ	Description
odata.context	string
value	Subscription[]	E-mailové předplatné Power BI

SubscriptionUser

Uživatel e-mailového předplatného Power BI

Name	Typ	Description
displayName	string	Zobrazovaný název objektu zabezpečení
emailAddress	string	E-mailová adresa uživatele
graphId	string	Identifikátor objektu zabezpečení v Microsoft Graphu. K dispozici pouze pro rozhraní API pro správu.
identifier	string	Identifikátor objektu zabezpečení
principalType	PrincipalType	Typ objektu zabezpečení
profile	ServicePrincipalProfile	Profil objektu zabezpečení služba Power BI. Relevantní pouze pro Power BI Embedded řešení s více tenanty.
userType	string	Typ uživatele.