Admin - Dashboards GetDashboardSubscriptionsAsAdmin

サービス:: Power BI REST APIs

API バージョン:: v1.0

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

権限

ユーザーは、ファブリック管理者であるか、サービスプリンシパルを使用して認証されている必要があります。
委任されたアクセス許可がサポートされています。

必要なスコープ

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	わかりました

例

Example

要求のサンプル

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

応答のサンプル

状態コード:: 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

列挙

プリンシパルの種類

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

ServicePrincipalProfile

Object

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

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

Subscription

Object

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

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

Subscriptions

Object

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

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

SubscriptionUser

Object

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

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

次の方法で共有

Admin - Dashboards GetDashboardSubscriptionsAsAdmin

権限

必要なスコープ

制限

URI パラメーター

応答

例

Example

要求のサンプル

応答のサンプル

定義

PrincipalType

ServicePrincipalProfile

Subscription

Subscriptions

SubscriptionUser