Admin - Dashboards GetDashboardsAsAdmin

サービス:: Power BI REST APIs

API バージョン:: v1.0

組織のダッシュボードの一覧を返します。

Permissions

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

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

必要なスコープ

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

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

制限事項

テナントあたり、1 時間あたり最大 50 要求、または 1 分あたり 5 要求。

GET https://api.powerbi.com/v1.0/myorg/admin/dashboards

省略可能なパラメーターを含む:

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

URI パラメーター

名前	/	型	説明
$expand	query	string	応答でインラインで展開されるデータ型のコンマ区切りのリストを受け入れます。 `tiles`をサポートします。
$filter	query	string	Odata フィルタークエリパラメーター条件に基づいて結果のサブセットを返します。
$skip	query	integer (int32)	最初の n 件の結果をスキップします
$top	query	integer (int32)	最初の n 個の結果のみを返します

応答

名前	型	説明
200 OK	AdminDashboards	[OK]

例

Example

要求のサンプル

GET https://api.powerbi.com/v1.0/myorg/admin/dashboards

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "id": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
      "displayName": "SalesMarketing",
      "embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
      "isReadOnly": false,
      "workspaceId": "abfbdc89-2659-43c1-9142-93e8378eac96"
    }
  ]
}

定義

名前	説明
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

Object

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

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

AdminDashboards

Object

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

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

AdminTile

Object

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

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

DashboardUser

Object

ダッシュボードの 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	ダッシュボード内のコンテンツに対するアクセス許可がない
Read	ダッシュボード内のコンテンツへの読み取りアクセス権を付与します
ReadWrite	ダッシュボード内のコンテンツに対する読み取りと書き込みのアクセス権を付与します
ReadReshare	ダッシュボード内のコンテンツへの読み取りと再共有のアクセス権を付与します
ReadCopy	ダッシュボード内のコンテンツへの読み取りとコピーのアクセス権を付与します
Owner	レポート内のコンテンツへの読み取り、書き込み、および再共有アクセスを許可します

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 呼び出しを使用します。

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 GetDashboardsAsAdmin

Permissions

必要なスコープ

制限事項

URI パラメーター

応答

例

Example

要求のサンプル

応答のサンプル

定義

AdminDashboard

AdminDashboards

AdminTile

DashboardUser

DashboardUserAccessRight

PrincipalType

ServicePrincipalProfile

Subscription

SubscriptionUser