Admin - Dashboards GetDashboardSubscriptionsAsAdmin

Referensi

Service:: Power BI REST APIs

API Version:: v1.0

Mengembalikan daftar langganan dasbor bersama dengan detail pelanggan. Ini adalah panggilan API pratinjau.

Izin

Pengguna harus memiliki hak administrator (seperti Office 365 Administrator Global atau Administrator Layanan Power BI) atau mengautentikasi menggunakan perwakilan layanan.
Izin yang didelegasikan didukung.

Cakupan yang Diperlukan

Tenant.Read.All atau Tenant.ReadWrite.All

Batasan

Maksimum 200 permintaan per jam.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
dashboardId	path	True	string uuid	ID dasbor

Respons

Nama	Jenis	Deskripsi
200 OK	Subscriptions	OK

Contoh

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

Definisi

Nama	Deskripsi
PrincipalType	Jenis utama
ServicePrincipalProfile	Profil utama layanan Power BI. Hanya relevan untuk solusi multi-penyewaan Power BI Embedded.
Subscription	Langganan email untuk item Power BI (seperti laporan atau dasbor)
Subscriptions	Pembungkus respons OData untuk langganan Power BI
SubscriptionUser	Pengguna langganan email Power BI

PrincipalType

Jenis utama

Nama	Jenis	Deskripsi
App	string	Jenis perwakilan layanan
Group	string	Jenis prinsipal grup
None	string	Tidak ada jenis utama. Gunakan untuk akses tingkat seluruh organisasi.
User	string	Jenis prinsipal pengguna

ServicePrincipalProfile

Profil utama layanan Power BI. Hanya relevan untuk solusi multi-penyewaan Power BI Embedded.

Nama	Jenis	Deskripsi
displayName	string	Nama profil perwakilan layanan
id	string	ID profil perwakilan layanan

Subscription

Langganan email untuk item Power BI (seperti laporan atau dasbor)

Nama	Jenis	Deskripsi
artifactDisplayName	string	Nama item Power BI langganan (seperti laporan atau dasbor)
artifactId	string	ID item Power BI langganan (seperti laporan atau dasbor)
artifactType	string	Jenis item Power BI (misalnya `Report`, , `Dashboard`atau `Dataset`)
attachmentFormat	string	Format laporan yang dilampirkan dalam langganan email
endDate	string	Tanggal dan waktu akhir langganan email
frequency	string	Frekuensi langganan email
id	string	ID langganan
isEnabled	boolean	Apakah langganan email diaktifkan
linkToContent	boolean	Apakah tautan langganan ada di langganan email
previewImage	boolean	Apakah cuplikan layar laporan ada di langganan email
startDate	string	Tanggal dan waktu mulai langganan email
subArtifactDisplayName	string	Nama halaman item Power BI langganan, jika merupakan laporan.
title	string	Nama aplikasi
users	SubscriptionUser[]	Detail setiap pelanggan email. Saat menggunakan panggilan Get User Subscriptions As Admin API, nilai yang dikembalikan adalah array kosong (null). Properti ini akan dihapus dari respons payload dalam rilis mendatang. Anda bisa mengambil informasi langganan pada laporan atau dasbor Power BI dengan menggunakan panggilan Dapatkan Langganan Laporan Sebagai Admin atau Dapatkan Langganan Dasbor Sebagai Admin API.

Subscriptions

Pembungkus respons OData untuk langganan Power BI

Nama	Jenis	Deskripsi
odata.context	string
value	Subscription[]	Langganan email Power BI

SubscriptionUser

Pengguna langganan email Power BI

Nama	Jenis	Deskripsi
displayName	string	Nama tampilan utama
emailAddress	string	Alamat email pengguna
graphId	string	Pengidentifikasi utama di Microsoft Graph. Hanya tersedia untuk API admin.
identifier	string	Pengidentifikasi utama
principalType	PrincipalType	Jenis utama
profile	ServicePrincipalProfile	Profil utama layanan Power BI. Hanya relevan untuk solusi multi-penyewaan Power BI Embedded.
userType	string	Jenis pengguna.

Share via