Datasets - Get Dataset

リファレンス

Service:: Power BI REST APIs

API Version:: v1.0

[マイワークスペース] から指定したデータセットを返します。

必要なスコープ

Dataset.ReadWrite.All または Dataset.Read.All

GET https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}

URI パラメーター

名前	/	必須	型	説明
datasetId	path	True	string	データセット ID

応答

名前	型	説明
200 OK	Dataset	OK

例

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229

Sample Response

Status code:: 200

{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "name": "SalesMarketing",
  "addRowsAPIEnabled": false,
  "configuredBy": "john@contoso.com",
  "isRefreshable": true,
  "isEffectiveIdentityRequired": true,
  "isEffectiveIdentityRolesRequired": true,
  "isOnPremGatewayRequired": false
}

定義

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

Dataset

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

名前	型	説明
ContentProviderType	string	データセットのコンテンツプロバイダーの種類
CreateReportEmbedURL	string	データセット作成レポートの埋め込み URL
CreatedDate	string	データセットの作成日時
Encryption	Encryption	データセットの暗号化情報。が指定されている場合 `$expand` にのみ適用されます。
IsEffectiveIdentityRequired	boolean	データセットに有効な ID が必要かどうか。これは GenerateToken API 呼び出しで送信する必要があります。
IsEffectiveIdentityRolesRequired	boolean	Power BI .pbix ファイル内で行レベルのセキュリティが定義されているかどうか。その場合は、ロールを指定する必要があります。
IsInPlaceSharingEnabled	boolean	データセットを外部ユーザーと共有して自分のテナントで使用できるかどうか
IsOnPremGatewayRequired	boolean	データセットにオンプレミスデータゲートウェイが必要かどうか
IsRefreshable	boolean	データセットが更新可能かどうか。 Power BI の更新可能なデータセットは、少なくとも 1 回更新されたデータセット、または有効な更新スケジュールが存在するデータセットです。
QnaEmbedURL	string	データセット Q&埋め込み URL
addRowsAPIEnabled	boolean	データセットで新しい行の追加が許可されるかどうか
configuredBy	string	データセットの所有者
description	string	データセットの説明
id	string	データセット ID
name	string	データセット名
queryScaleOutSettings	DatasetQueryScaleOutSettings	データセットのクエリスケールアウト設定
targetStorageMode	string	データセットストレージモード
upstreamDataflows	DependentDataflow[]	この項目が依存するすべてのデータフローの一覧
users	DatasetUser[]	(空の値)データセットのユーザーアクセスの詳細。このプロパティは、今後のリリースでペイロード応答から削除されます。 Power BI アイテム (レポートやダッシュボードなど) のユーザー情報を取得するには、データセットユーザーを管理 API として取得するか、パラメーターを指定して PostWorkspaceInfo API を`getArtifactUsers`使用します。
webUrl	string	データセットの Web URL

DatasetQueryScaleOutSettings

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

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

DatasetUser

データセットの 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	string	データセット内のコンテンツに対するアクセス許可を削除します
Read	string	データセット内のコンテンツへの読み取りアクセス権を付与します
ReadExplore	string	データセット内のコンテンツへの読み取りと探索のアクセス権を付与します
ReadReshare	string	データセット内のコンテンツへの読み取りと再共有のアクセス権を付与します
ReadReshareExplore	string	データセット内のコンテンツへの読み取り、再共有、探索アクセスを許可します
ReadWrite	string	データセット内のコンテンツに対する読み取りと書き込みのアクセス権を付与します
ReadWriteExplore	string	データセット内のコンテンツへの読み取り、書き込み、探索のアクセス権を付与します
ReadWriteReshare	string	データセット内のコンテンツへの読み取り、書き込み、再共有のアクセス権を付与します
ReadWriteReshareExplore	string	データセット内のコンテンツへの読み取り、書き込み、再共有、探索アクセスを許可します

DependentDataflow

Power BI 依存データフロー

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

Encryption

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

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

EncryptionStatus

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

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

PrincipalType

プリンシパルの種類

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

ServicePrincipalProfile

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

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

次の方法で共有