Admin - Dashboards GetDashboardSubscriptionsAsAdmin

リファレンス

Service:: Power BI REST APIs

API Version:: v1.0

サブスクライバーの詳細と共にダッシュボードサブスクリプションの一覧を返します。これはプレビュー API 呼び出しです。

アクセス許可

ユーザーは管理者権限 (Office 365グローバル管理者や Power BI サービス管理者など) を持っているか、サービスプリンシパルを使用して認証する必要があります。
委任されたアクセス許可がサポートされています。

必要なスコープ

Tenant.Read.All または Tenant.ReadWrite.All

制限事項

1 時間あたり最大 200 要求。

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

URI パラメーター

名前	/	必須	型	説明
dashboardId	path	True	string uuid	ダッシュボード ID

応答

名前	型	説明
200 OK	Subscriptions	OK

例

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

定義

名前	説明
PrincipalType	プリンシパルの種類
ServicePrincipalProfile	Power BI サービスプリンシパルプロファイル。マルチテナントソリューションPower BI Embeddedにのみ関連します。
Subscription	Power BI アイテム (レポートやダッシュボードなど) のメールサブスクリプション
Subscriptions	Power BI サブスクリプションの OData 応答ラッパー
SubscriptionUser	Power BI メールサブスクリプションユーザー

PrincipalType

プリンシパルの種類

名前	型	説明
App	string	サービスプリンシパルの種類
Group	string	グループプリンシパルの種類
None	string	プリンシパルの種類はありません。 organization レベル全体のアクセスに使用します。
User	string	ユーザープリンシパルの種類

ServicePrincipalProfile

Power BI サービスプリンシパルプロファイル。マルチテナントソリューションPower BI Embeddedにのみ関連します。

名前	型	説明
displayName	string	サービスプリンシパルプロファイル名
id	string	サービスプリンシパルプロファイル ID

Subscription

Power BI アイテム (レポートやダッシュボードなど) のメールサブスクリプション

名前	型	説明
artifactDisplayName	string	サブスクライブした Power BI アイテムの名前 (レポートやダッシュボードなど)
artifactId	string	サブスクライブした Power BI アイテムの ID (レポートやダッシュボードなど)
artifactType	string	Power BI 項目の種類 (、、`Dashboard`または `Dataset`など`Report`)
attachmentFormat	string	メールサブスクリプションに添付されているレポートの形式
endDate	string	メールサブスクリプションの終了日時
frequency	string	メールサブスクリプションの頻度
id	string	サブスクリプション ID
isEnabled	boolean	メールサブスクリプションが有効になっているかどうか
linkToContent	boolean	メールサブスクリプションにサブスクリプションリンクが存在するかどうか
previewImage	boolean	レポートのスクリーンショットがメールサブスクリプションに存在するかどうか
startDate	string	電子メールサブスクリプションの開始日時
subArtifactDisplayName	string	サブスクライブした Power BI アイテムのページ名 (レポートの場合)。
title	string	アプリの名前
users	SubscriptionUser[]	各メールサブスクライバーの詳細。 Get User Subscriptions As 管理 API 呼び出しを使用する場合、返される値は空の配列 (null) です。このプロパティは、今後のリリースでペイロード応答から削除されます。 Power BI レポートまたはダッシュボードでサブスクリプション情報を取得するには、[レポートサブスクリプションを管理として取得] または [ダッシュボードサブスクリプションを取得する] 管理 API 呼び出しを使用します。

Subscriptions

Power BI サブスクリプションの OData 応答ラッパー

名前	型	説明
odata.context	string
value	Subscription[]	Power BI メールサブスクリプション

SubscriptionUser

Power BI メールサブスクリプションユーザー

名前	型	説明
displayName	string	プリンシパルの表示名
emailAddress	string	ユーザーの電子メールアドレス
graphId	string	Microsoft Graph のプリンシパルの識別子。管理者 API でのみ使用できます。
identifier	string	プリンシパルの識別子
principalType	PrincipalType	プリンシパルの種類
profile	ServicePrincipalProfile	Power BI サービスプリンシパルプロファイル。マルチテナントソリューションPower BI Embeddedにのみ関連します。
userType	string	ユーザーの種類。

Share via