Admin - Dashboards GetDashboardSubscriptionsAsAdmin

Služba:

Power BI REST APIs

Verze rozhraní API:

v1.0

Vrátí seznam odběrů řídicích panelů spolu s podrobnostmi o odběrateli. Jedná se o volání rozhraní API ve verzi Preview.

Povolení

• Uživatel musí být správcem infrastruktury nebo se musí ověřit pomocí instančního objektu.
• Delegovaná oprávnění jsou podporována.

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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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 instančního objektu Power BI. Platí jenom pro víceklientské řešení Power BI Embedded.
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

Výčet

Typ objektu zabezpečení

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

ServicePrincipalProfile

Objekt

Profil instančního objektu Power BI. Platí jenom pro víceklientské řešení Power BI Embedded.

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

Subscription

Objekt

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 sestava nebo řídicí panel)
artifactId	string (uuid)	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 (date-time)	Koncové datum a čas odběru e-mailu
frequency	string	Frekvence odběru e-mailů
id	string (uuid)	ID předplatného
isEnabled	boolean	Jestli je povolené e-mailové předplatné
linkToContent	boolean	Jestli odkaz na odběr existuje v e-mailovém předplatném
previewImage	boolean	Jestli v odběru e-mailu existuje snímek obrazovky sestavy
startDate	string (date-time)	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 pro získání uživatelských předplatných jako správce 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 můžete načíst na sestavě nebo řídicím panelu Power BI pomocí volání rozhraní API pro získání předplatných sestav jako správce nebo získání odběrů řídicích panelů jako volání rozhraní API pro správu.

Subscriptions

Objekt

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

Objekt

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 instančního objektu Power BI. Platí jenom pro víceklientské řešení Power BI Embedded.
userType	string	Typ uživatele