Admin - Dataflows GetDataflowsAsAdmin

リファレンス

Service:: Power BI REST APIs

API Version:: v1.0

組織のデータフローの一覧を返します。

アクセス許可

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

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

必要なスコープ

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

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

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

With optional parameters:

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

URI パラメーター

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

応答

名前	型	説明
200 OK	AdminDataflows	OK

例

Example

Sample Request

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "objectId": "bd32e5c0-363f-430b-a03b-5535a4804b9b",
      "name": "AdventureWorks",
      "description": "Our Adventure Works",
      "modelUrl": "https://MyDataflowStorageAccount.dfs.core.windows.net/powerbi/contoso/AdventureWorks/model.json",
      "configuredBy": "john@contoso.com",
      "workspaceId": "6369a442-4bc4-425c-916d-460c42be746b"
    }
  ]
}

定義

名前	説明
AdminDataflow	管理 API によって返されるデータフローのメタデータ。データフローで返される可能性があるプロパティの一覧を次に示します。呼び出される API、呼び出し元のアクセス許可、および Power BI データベース内のデータの可用性に応じて、プロパティのサブセットのみが返されます。
AdminDataflows	Power BI 管理データフローコレクションの OData 応答ラッパー
DataflowUser	データフローの Power BI ユーザーアクセス権エントリ
DataflowUserAccessRight	ユーザーがデータフローに対して持っているアクセス権 (アクセス許可レベル)
PrincipalType	プリンシパルの種類
ServicePrincipalProfile	Power BI サービスプリンシパルプロファイル。マルチテナントソリューションPower BI Embeddedにのみ関連します。

AdminDataflow

管理 API によって返されるデータフローのメタデータ。データフローで返される可能性があるプロパティの一覧を次に示します。呼び出される API、呼び出し元のアクセス許可、および Power BI データベース内のデータの可用性に応じて、プロパティのサブセットのみが返されます。

名前	型	説明
configuredBy	string	データフローの所有者
description	string	データフローの説明
modelUrl	string	データフロー定義ファイル (model.json) への URL
modifiedBy	string	データフローを変更したユーザー
modifiedDateTime	string	データフローが最後に変更された日時
name	string	データフロー名
objectId	string	データフロー ID
users	DataflowUser[]	(空の値)データフローユーザーアクセスの詳細。このプロパティは、今後のリリースでペイロード応答から削除されます。 Power BI データフローのユーザー情報を取得するには、get Dataflow Users as 管理 API 呼び出し、または PostWorkspaceInfo API 呼び出しとパラメーターを`getArtifactUser`使用します。
workspaceId	string	データフローワークスペース ID。

AdminDataflows

Power BI 管理データフローコレクションの OData 応答ラッパー

名前	型	説明
odata.context	string	OData コンテキスト
value	AdminDataflow[]	レポートコレクション

DataflowUser

データフローの Power BI ユーザーアクセス権エントリ

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

DataflowUserAccessRight

ユーザーがデータフローに対して持っているアクセス権 (アクセス許可レベル)

名前	型	説明
None	string	データフロー内のコンテンツに対するアクセス許可を削除します
Owner	string	データフロー内のコンテンツへの読み取り、書き込み、および再共有アクセスを許可します
Read	string	データフロー内のコンテンツへの読み取りアクセス権を付与します
ReadReshare	string	データフロー内のコンテンツへの読み取りと再共有のアクセスを許可します
ReadWrite	string	データフロー内のコンテンツへの読み取りと書き込みのアクセス権を付与します

PrincipalType

プリンシパルの種類

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

ServicePrincipalProfile

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

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