Admin - Dashboards GetDashboardsInGroupAsAdmin

リファレンス

Service:: Power BI REST APIs

API Version:: v1.0

指定したワークスペースからダッシュボードの一覧を返します。

アクセス許可

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

サービスの prinicipal 認証で実行する場合、アプリには、Azure portalで Power BI に対して管理者の同意が必要な事前使用許可が設定されていない必要があります。

必要なスコープ

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

標準の委任された管理者アクセストークンを使用して認証する場合にのみ関連します。サービスプリンシパル経由の認証を使用する場合は、存在しない必要があります。

制限事項

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

GET https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/dashboards

With optional parameters:

GET https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/dashboards?$filter={$filter}&$top={$top}&$skip={$skip}

URI パラメーター

名前	/	必須	型	説明
groupId	path	True	string uuid	ワークスペース ID
$filter	query		string	ブール条件に基づいて結果をフィルター処理する
$skip	query		integer int32	最初の n 個の結果をスキップします
$top	query		integer int32	最初の n 個の結果のみを返します

応答

名前	型	説明
200 OK	AdminDashboards	OK

例

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dashboards

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
      "displayName": "SalesMarketing",
      "embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af&groupId=f089354e-8366-4e18-aea3-4cb4a3a50b48",
      "isReadOnly": false
    }
  ]
}

定義

名前	説明
AdminDashboard	管理 API によって返される Power BI ダッシュボード。 API は、次のダッシュボードプロパティの一覧のサブセットを返します。サブセットは、呼び出される API、呼び出し元のアクセス許可、および Power BI データベース内のデータの可用性に依存します。
AdminDashboards	Power BI ダッシュボードコレクションの OData 応答ラッパー
AdminTile	管理 API によって返される Power BI タイル。
DashboardUser	ダッシュボードの Power BI ユーザーアクセス権エントリ
DashboardUserAccessRight	ユーザーがダッシュボードに対して持っているアクセス権 (アクセス許可レベル)
PrincipalType	プリンシパルの種類
ServicePrincipalProfile	Power BI サービスプリンシパルプロファイル。マルチテナントソリューションPower BI Embeddedにのみ関連します。
Subscription	Power BI アイテムのメールサブスクリプション (レポートやダッシュボードなど)
SubscriptionUser	Power BI メールサブスクリプションユーザー

AdminDashboard

管理 API によって返される Power BI ダッシュボード。 API は、次のダッシュボードプロパティの一覧のサブセットを返します。サブセットは、呼び出される API、呼び出し元のアクセス許可、および Power BI データベース内のデータの可用性に依存します。

名前	型	説明
appId	string	ダッシュボードがアプリに属している場合にのみ返されるアプリ ID
displayName	string	ダッシュボードの表示名
embedUrl	string	ダッシュボードの埋め込み URL
id	string	ダッシュボード ID
isReadOnly	boolean	ダッシュボードが読み取り専用かどうか
subscriptions	Subscription[]	(空の値)Power BI アイテム (レポートやダッシュボードなど) のサブスクリプションの詳細。このプロパティは、今後のリリースでペイロード応答から削除されます。 Power BI レポートのサブスクリプション情報を取得するには、API 呼び出しとしてレポートサブスクリプションの取得管理使用します。
tiles	AdminTile[]	ダッシュボードに属するタイル
users	DashboardUser[]	(空の値)ダッシュボードのユーザーアクセスの詳細。このプロパティは、今後のリリースでペイロード応答から削除されます。 Power BI ダッシュボードでユーザー情報を取得するには、管理 API 呼び出しとしてダッシュボードユーザーを取得するか、パラメーターを指定して PostWorkspaceInfo API 呼び出しを`getArtifactUsers`使用します。
webUrl	string	ダッシュボードの Web URL
workspaceId	string	ダッシュボードのワークスペース ID (GUID)。このプロパティは、GetDashboardsAsAdmin でのみ返されます。

AdminDashboards

Power BI ダッシュボードコレクションの OData 応答ラッパー

名前	型	説明
odata.context	string	OData コンテキスト
value	AdminDashboard[]	ダッシュボードコレクション

AdminTile

管理 API によって返される Power BI タイル。

名前	型	説明
colSpan	integer	タイルスパン列の数
datasetId	string	データセット ID。レポートから作成されたタイル、または Q&A タイルなどのデータセットを使用して作成されたタイルでのみ使用できます。
embedData	string	タイルの埋め込みデータ
embedUrl	string	タイルの埋め込み URL
id	string	タイル ID
reportId	string	レポート ID。レポートから作成されたタイルでのみ使用できます。
rowSpan	integer	タイルスパン行の数
title	string	タイルの表示名

DashboardUser

ダッシュボードの Power BI ユーザーアクセス権エントリ

名前	型	説明
dashboardUserAccessRight	DashboardUserAccessRight	ユーザーがダッシュボードに対して持っているアクセス権 (アクセス許可レベル)
displayName	string	プリンシパルの表示名
emailAddress	string	ユーザーの電子メールアドレス
graphId	string	Microsoft Graph のプリンシパルの識別子。管理者 API でのみ使用できます。
identifier	string	プリンシパルの識別子
principalType	PrincipalType	プリンシパルの種類
profile	ServicePrincipalProfile	Power BI サービスプリンシパルプロファイル。マルチテナントソリューションPower BI Embeddedにのみ関連します。
userType	string	ユーザーの種類。

DashboardUserAccessRight

ユーザーがダッシュボードに対して持っているアクセス権 (アクセス許可レベル)

名前	型	説明
None	string	ダッシュボード内のコンテンツに対するアクセス許可がない
Owner	string	レポート内のコンテンツへの読み取り、書き込み、再共有のアクセス権を付与します
Read	string	ダッシュボード内のコンテンツへの読み取りアクセス権を付与します
ReadCopy	string	ダッシュボード内のコンテンツへの読み取りとコピーのアクセス権を付与します
ReadReshare	string	ダッシュボード内のコンテンツへの読み取りと再共有のアクセス権を付与します
ReadWrite	string	ダッシュボード内のコンテンツへの読み取りと書き込みのアクセス権を付与します

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 項目の種類 (、、または `Dataset`など`ReportDashboard`)
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 呼び出しとして取得する] を使用します。

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	ユーザーの種類。

次の方法で共有