Push Datasets - Datasets PostDataset

リファレンス

Service:: Power BI REST APIs

API Version:: v1.0

マイワークスペースに新しいデータセットを作成します。

必要なスコープ

Dataset.ReadWrite.All

制限事項

この API 呼び出しでは、 プッシュデータセットのみがサポートされます。制限事項の完全な一覧については、「プッシュデータセットの制限事項」を参照してください。

POST https://api.powerbi.com/v1.0/myorg/datasets

With optional parameters:

POST https://api.powerbi.com/v1.0/myorg/datasets?defaultRetentionPolicy={defaultRetentionPolicy}

URI パラメーター

名前	/	必須	型	説明
defaultRetentionPolicy	query		DefaultRetentionPolicy	既定のアイテム保持ポリシー

要求本文

名前	必須	型	説明
name	True	string	データセット名
tables	True	Table[]	データセットテーブル
datasources		Datasource[]	このデータセットに関連付けられているデータソース
defaultMode		DatasetMode	データセットのモードまたは種類
relationships		Relationship[]	データセットのリレーションシップ

応答

名前	型	説明
201 Created	Dataset	作成済み
202 Accepted	Dataset	同意

例

Push example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/datasets?defaultRetentionPolicy=basicFIFO

Request Body

{
  "name": "SalesMarketing",
  "defaultMode": "Push",
  "tables": [
    {
      "name": "Product",
      "columns": [
        {
          "name": "ProductID",
          "dataType": "Int64"
        },
        {
          "name": "Name",
          "dataType": "string"
        },
        {
          "name": "Category",
          "dataType": "string"
        },
        {
          "name": "IsCompete",
          "dataType": "bool"
        },
        {
          "name": "ManufacturedOn",
          "dataType": "DateTime"
        },
        {
          "name": "Sales",
          "dataType": "Int64",
          "formatString": "Currency"
        }
      ]
    }
  ]
}

Sample Response

Status code:: 201

{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "name": "SalesMarketing",
  "defaultRetentionPolicy": "basicFIFO"
}

定義

名前	説明
ASMashupExpression	データセットテーブルソース
Column	データセット列
CreateDatasetRequest	Power BI データセット
CrossFilteringBehavior	リレーションシップのフィルターの方向
Dataset	Power BI データセット。この API は、次のデータセットプロパティの一覧のサブセットを返します。サブセットは、呼び出される API、呼び出し元のアクセス許可、および Power BI データベース内のデータの可用性によって異なります。
DatasetMode	データセットのモードまたは種類
DatasetQueryScaleOutSettings	データセットのスケールアウト設定のクエリ
DatasetUser	データセットの Power BI ユーザーアクセス権エントリ
DatasetUserAccessRight	ユーザーがデータセットに対して持っているアクセス権 (アクセス許可レベル)
Datasource	Power BI データソース
DatasourceConnectionDetails	Power BI データソース接続の詳細。「データソースの取得」または「グループ内のデータソースの取得」の例を参照してください。
DefaultRetentionPolicy	既定のアイテム保持ポリシー
DependentDataflow	Power BI 依存データフロー
Encryption	データセットの暗号化情報
EncryptionStatus	データセットの暗号化の状態
Measure	Power BI メジャー
PrincipalType	プリンシパルの種類
Relationship	データセット内のテーブル間のリレーションシップ
Row	データセット内のデータ行
ServicePrincipalProfile	Power BI サービスプリンシパルプロファイル。マルチテナントソリューションPower BI Embeddedにのみ関連します。
Table	データセットテーブル

ASMashupExpression

データセットテーブルソース

名前	型	説明
expression	string	ソース式

Column

データセット列

名前	型	説明
dataCategory	string	省略可能。この列内のデータを記述するデータカテゴリに使用される文字列値。
dataType	string	列データ型
formatString	string	省略可能。 FORMAT_STRINGで指定された列の形式。
isHidden	boolean	省略可能。列が非表示かどうか。既定値は、`false` です。
name	string	列名
sortByColumn	string	省略可能。同一テーブル内の列の文字列名であり、現在の列を並べ替えるために使用されます。
summarizeBy	string	省略可能。この列の集計に使用する集計関数。

CreateDatasetRequest

Power BI データセット

名前	型	説明
datasources	Datasource[]	このデータセットに関連付けられているデータソース
defaultMode	DatasetMode	データセットのモードまたは種類
name	string	データセット名
relationships	Relationship[]	データセットのリレーションシップ
tables	Table[]	データセットテーブル

CrossFilteringBehavior

リレーションシップのフィルターの方向

名前	型	説明
Automatic	string	クロスフィルター処理の動作が自動的に定義される
BothDirections	string	フィルター処理の目的で、両方のテーブルが 1 つのテーブルとして扱われます。
OneDirection	string	フィルター処理の目的で、値が集計されているテーブルにフィルターが適用されます。

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&A 埋め込み 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

DatasetMode

データセットのモードまたは種類

名前	型	説明
AsAzure	string	Azure Analysis Servicesへのライブ接続を持つデータセット
AsOnPrem	string	オンプレミス Azure Analysis Servicesへのライブ接続を持つデータセット
Push	string	Power BI にデータをプッシュするためのプログラムによるアクセスを許可するデータセット
PushStreaming	string	データストリーミングをサポートし、Power BI にデータをプッシュするためのプログラムによるアクセスを許可するデータセット
Streaming	string	データストリーミングをサポートするデータセット。詳細については、「Power BI のリアルタイムストリーミング」をご覧ください。

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	データセット内のコンテンツへの読み取り、書き込み、再共有、探索アクセスを許可します

Datasource

Power BI データソース

名前	型	説明
connectionDetails	DatasourceConnectionDetails	データソース接続の詳細
connectionString	string	(非推奨)データソース接続文字列。 DirectQuery でのみ使用できます。
datasourceId	string	バインドされたデータソース ID。ゲートウェイにバインドされていない場合は空です
datasourceType	string	データソースの種類
gatewayId	string	バインドされたゲートウェイ ID。ゲートウェイにバインドされていない場合は空です。ゲートウェイクラスターを使用する場合、ゲートウェイ ID はクラスター内のプライマリ (最初の) ゲートウェイを参照し、ゲートウェイクラスター ID と似ています。
name	string	(非推奨)データソース名。 DirectQuery でのみ使用できます。

DatasourceConnectionDetails

Power BI データソース接続の詳細。「データソースの取得」または「グループ内のデータソースの取得」の例を参照してください。

名前	型	説明
account	string	接続アカウント
classInfo	string	接続クラス情報
database	string	接続データベース
domain	string	接続ドメイン
emailAddress	string	接続メールアドレス
kind	string	接続の種類
loginServer	string	接続ログインサーバー
path	string	接続パス
server	string	接続サーバー
url	string	接続 URL

DefaultRetentionPolicy

既定のアイテム保持ポリシー

名前	型	説明
None	string	なし
basicFIFO	string	basicFIFO

DependentDataflow

Power BI 依存データフロー

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

Encryption

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

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

EncryptionStatus

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

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

Measure

Power BI メジャー

名前	型	説明
description	string	省略可能。メジャーの説明。
expression	string	有効な DAX 式
formatString	string	省略可能。 FORMAT_STRINGで指定されたとおりに値を表示する場合の書式設定方法を説明する文字列。
isHidden	boolean	省略可能。メジャーが非表示かどうか。
name	string	メジャー名

PrincipalType

プリンシパルの種類

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

Relationship

データセット内のテーブル間のリレーションシップ

名前	型	既定値	説明
crossFilteringBehavior	CrossFilteringBehavior	OneDirection	リレーションシップのフィルターの方向
fromColumn	string		外部キー列の名前
fromTable	string		外部キーテーブルの名前
name	string		リレーションシップの名前と識別子
toColumn	string		主キー列の名前
toTable	string		主キーテーブルの名前

Row

データセット内のデータ行

名前	型	説明
id	string	一意の行 ID

ServicePrincipalProfile

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

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

Table

データセットテーブル

名前	型	説明
columns	Column[]	このテーブルの列スキーマ
description	string	テーブルの説明
isHidden	boolean	省略可能。このデータセットテーブルが非表示かどうか。
measures	Measure[]	このテーブル内のメジャー
name	string	テーブル名
rows	Row[]	このテーブル内のデータ行
source	ASMashupExpression[]	テーブルソース