Admin - Dashboards GetDashboardSubscriptionsAsAdmin

Riferimento

Service:: Power BI REST APIs

API Version:: v1.0

Restituisce un elenco di sottoscrizioni del dashboard insieme ai dettagli del sottoscrittore. Si tratta di una chiamata API di anteprima.

Autorizzazioni

L'utente deve disporre dei diritti di amministratore( ad esempio Office 365 amministratore globale o amministratore del servizio Power BI) o eseguire l'autenticazione tramite un'entità servizio.
Le autorizzazioni delegate sono supportate.

Ambito obbligatorio

Tenant.Read.All o Tenant.ReadWrite.All

Limitazioni

Numero massimo di 200 richieste all'ora.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
dashboardId	path	True	string uuid	The dashboard ID

Risposte

Nome	Tipo	Descrizione
200 OK	Subscriptions	OK

Esempio

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

Definizioni

Nome	Descrizione
PrincipalType	Tipo di entità
ServicePrincipalProfile	Profilo principale servizio Power BI. Rilevante solo per Power BI Embedded soluzione multi-tenancy.
Subscription	Sottoscrizione di posta elettronica per un elemento di Power BI (ad esempio un report o un dashboard)
Subscriptions	Wrapper di risposta OData per le sottoscrizioni di Power BI
SubscriptionUser	Un utente della sottoscrizione di posta elettronica di Power BI

PrincipalType

Tipo di entità

Nome	Tipo	Descrizione
App	string	Tipo di entità servizio
Group	string	Tipo di entità gruppo
None	string	Nessun tipo di entità. Usare per l'accesso a livello di intera organizzazione.
User	string	Tipo di entità utente

ServicePrincipalProfile

Profilo principale servizio Power BI. Rilevante solo per Power BI Embedded soluzione multi-tenancy.

Nome	Tipo	Descrizione
displayName	string	Nome del profilo dell'entità servizio
id	string	ID del profilo dell'entità servizio

Subscription

Sottoscrizione di posta elettronica per un elemento di Power BI (ad esempio un report o un dashboard)

Nome	Tipo	Descrizione
artifactDisplayName	string	Nome dell'elemento di Power BI sottoscritto , ad esempio un report o un dashboard.
artifactId	string	ID dell'elemento di Power BI sottoscritto (ad esempio un report o un dashboard)
artifactType	string	Tipo di elemento di Power BI ( ad esempio `Report`, `Dashboard`o `Dataset`)
attachmentFormat	string	Formato del report allegato nella sottoscrizione di posta elettronica
endDate	string	Data e ora di fine della sottoscrizione di posta elettronica
frequency	string	Frequenza della sottoscrizione di posta elettronica
id	string	ID sottoscrizione
isEnabled	boolean	Indica se la sottoscrizione di posta elettronica è abilitata
linkToContent	boolean	Indica se esiste un collegamento di sottoscrizione nella sottoscrizione di posta elettronica
previewImage	boolean	Indica se nella sottoscrizione di posta elettronica è presente uno screenshot del report
startDate	string	Data e ora di inizio della sottoscrizione di posta elettronica
subArtifactDisplayName	string	Nome della pagina dell'elemento di Power BI sottoscritto, se si tratta di un report.
title	string	Nome dell'app
users	SubscriptionUser[]	Dettagli di ogni sottoscrittore di posta elettronica. Quando si usa la chiamata api Get User Subscriptions As Amministrazione, il valore restituito è una matrice vuota (null). Questa proprietà verrà rimossa dalla risposta del payload in una versione futura. È possibile recuperare le informazioni sulla sottoscrizione in un report o un dashboard di Power BI usando get report subscriptions As Amministrazione (Ottieni sottoscrizioni report) o Get Dashboard Subscriptions As Amministrazione API calls (Ottieni sottoscrizioni report come Amministrazione chiamate API).

Subscriptions

Wrapper di risposta OData per le sottoscrizioni di Power BI

Nome	Tipo	Descrizione
odata.context	string
value	Subscription[]	Sottoscrizione di posta elettronica di Power BI

SubscriptionUser

Un utente della sottoscrizione di posta elettronica di Power BI

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato dell'entità
emailAddress	string	Indirizzo di posta elettronica dell'utente
graphId	string	Identificatore dell'entità in Microsoft Graph. Disponibile solo per le API di amministrazione.
identifier	string	Identificatore dell'entità
principalType	PrincipalType	Tipo di entità
profile	ServicePrincipalProfile	Profilo principale servizio Power BI. Rilevante solo per Power BI Embedded soluzione multi-tenancy.
userType	string	Tipo di utente.

Condividi tramite