Admin - Datasets GetDatasetsAsAdmin

サービス:

Power BI REST APIs

API バージョン:

v1.0

組織のデータセットの一覧を返します。

権限

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

サービス 特権認証で実行する場合、アプリ は、Azure portal で Power BI に対して管理者の同意が必要な事前使用許可を設定 することはできません。

必要なスコープ

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

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

制限

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

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

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

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

URI パラメーター

名前	/	必須	型	説明
$filter	query		string	Odata フィルター クエリ パラメーター条件 基づいて、結果のサブセットを返します。
$skip	query		integer (int32)	最初の n 件の結果をスキップします
$top	query		integer (int32)	最初の n 個の結果のみを返します

応答

名前	型	説明
200 OK	AdminDatasets	わかりました

例

Example

要求のサンプル

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

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "name": "SalesMarketing",
      "addRowsAPIEnabled": false,
      "configuredBy": "john@contoso.com",
      "isRefreshable": true,
      "isEffectiveIdentityRequired": false,
      "isEffectiveIdentityRolesRequired": false,
      "isOnPremGatewayRequired": false,
      "isInPlaceSharingEnabled": false,
      "workspaceId": "5c968528-70b6-4588-809f-ce811ffa5c23"
    }
  ]
}

定義

名前	説明
AdminDataset	管理者 API によって返される Power BI データセット。 この API は、次のデータセット プロパティの一覧のサブセットを返します。 サブセットは、呼び出された API、呼び出し元のアクセス許可、および Power BI データベース内のデータの可用性に依存します。
AdminDatasets	データセット odata リスト ラッパー
DatasetQueryScaleOutSettings	データセットのスケールアウト設定のクエリ
DatasetUser	データセットの Power BI ユーザー アクセス権エントリ
DatasetUserAccessRight	ユーザーがデータセットに対して持っているアクセス権 (アクセス許可レベル)
DependentDataflow	Power BI 依存データフロー
Encryption	データセットの暗号化情報
EncryptionStatus	データセットの暗号化の状態
PrincipalType	プリンシパルの種類
ServicePrincipalProfile	Power BI サービス プリンシパル プロファイル。 Power BI Embedded マルチテナント ソリューションにのみ関連します。

AdminDataset

Object

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

名前	型	説明
ContentProviderType	string	無視する必要がある非推奨のプロパティ。
Encryption	Encryption	データセットの暗号化情報。 $expand が指定されている場合にのみ適用されます。
IsEffectiveIdentityRequired	boolean	データセットに有効な ID が必要かどうか。これは、GenerateToken API 呼び出しで送信する必要があります。
IsEffectiveIdentityRolesRequired	boolean	行レベルのセキュリティが Power BI .pbix ファイル内で定義されているかどうか。 その場合は、ロールを指定する必要があります。
IsInPlaceSharingEnabled	boolean	データセットを外部ユーザーと共有して自分のテナントで使用できるかどうかを指定します。
IsOnPremGatewayRequired	boolean	データセットにオンプレミス データ ゲートウェイが必要かどうか
IsRefreshable	boolean	このフィールドは、データセットが最近更新されたとき、または自動更新用に構成され、接続モードが特に "インポート" に設定されている場合に、true を返します。 この値は、データセットが手動で更新されるか、自動更新用に設定されているかに関係なく、'DirectQuery' や 'LiveConnection' などの他の接続モードの false を返します。
addRowsAPIEnabled	boolean	データセットで新しい行の追加が許可されるかどうか
configuredBy	string	データセットの所有者
createReportEmbedURL	string	データセット作成レポートの埋め込み URL
createdDate	string (date-time)	データセットの作成日時
description	string	データセットの説明
id	string	データセット ID
name	string	データセット名
qnaEmbedURL	string	データセット Q&A 埋め込み URL
queryScaleOutSettings	DatasetQueryScaleOutSettings	データセットのスケールアウト設定のクエリ
targetStorageMode	string	データセットストレージモード
upstreamDataflows	DependentDataflow[]	この項目が依存するすべてのデータフローの一覧
users	DatasetUser[]	(空の値)データセット のユーザー アクセスの詳細。 このプロパティは、今後のリリースでペイロードの応答から削除されます。 Power BI アイテム (レポートやダッシュボードなど) のユーザー情報を取得するには、Admin API としてデータセット ユーザーを取得するか、 パラメーターを使用して getArtifactUsers API を使用します。
webUrl	string	データセットの Web URL
workspaceId	string (uuid)	データセット ワークスペース ID。 このプロパティは、GetDatasetsAsAdmin でのみ返されます。

AdminDatasets

Object

データセット odata リスト ラッパー

名前	型	説明
@odata.context	string	OData コンテキスト
value	AdminDataset[]	データセット

DatasetQueryScaleOutSettings

Object

データセットのスケールアウト設定のクエリ

名前	型	説明
autoSyncReadOnlyReplicas	boolean	データセットが読み取り専用レプリカを自動的に同期するかどうか
maxReadOnlyReplicas	integer minimum: -1 maximum: 64	データセットの読み取り専用レプリカの最大数 (レプリカの自動数の場合は 0 から 64、-1)

DatasetUser

Object

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

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

DatasetUserAccessRight

列挙

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

値	説明
None	データセット内のコンテンツへのアクセス許可を削除します
Read	データセット内のコンテンツへの読み取りアクセス権を付与します
ReadExplore	データセット内のコンテンツへの読み取りと探索のアクセス権を付与します
ReadReshare	データセット内のコンテンツへの読み取りと再共有のアクセス権を付与します
ReadReshareExplore	データセット内のコンテンツへの読み取り、再共有、探索アクセスを許可します
ReadWrite	データセット内のコンテンツに対する読み取りと書き込みのアクセス権を付与します
ReadWriteExplore	データセット内のコンテンツへの読み取り、書き込み、探索のアクセス権を付与します
ReadWriteReshare	データセット内のコンテンツへの読み取り、書き込み、および再共有アクセスを許可します
ReadWriteReshareExplore	データセット内のコンテンツへの読み取り、書き込み、再共有、探索アクセスを許可します

DependentDataflow

Object

Power BI 依存データフロー

名前	型	説明
groupId	string	ターゲット グループ ID
targetDataflowId	string	ターゲット データフロー ID

Encryption

Object

データセットの暗号化情報

名前	型	説明
EncryptionStatus	EncryptionStatus	データセットの暗号化の状態

EncryptionStatus

列挙

データセットの暗号化の状態

値	説明
InSyncWithWorkspace	暗号化はサポートされており、暗号化設定と同期されています
NotInSyncWithWorkspace	暗号化はサポートされていますが、暗号化設定と同期されていません
NotSupported	このデータセットでは暗号化はサポートされていません
Unknown	データセットの破損により、暗号化の状態が不明です

PrincipalType

列挙

プリンシパルの種類

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

ServicePrincipalProfile

Object

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

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