Push Datasets - Datasets PostDatasetInGroup

サービス:

Power BI REST APIs

API バージョン:

v1.0

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

必要なスコープ

Dataset.ReadWrite.All

制限事項

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

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets

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

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

URI パラメーター

名前	/	必須	型	説明
groupId	path	True	string (uuid)	ワークスペース ID
defaultRetentionPolicy	query		DefaultRetentionPolicy	既定のアイテム保持ポリシー

要求本文

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

応答

名前	型	説明
201 Created	Dataset	作成
202 Accepted	Dataset	受け入れられた

例

Push example

要求のサンプル

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets?defaultRetentionPolicy=basicFIFO

要求本文

{
  "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"
        }
      ]
    }
  ]
}

応答のサンプル

状態コード:

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

Object

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

名前	型	説明
expression	string	ソース式

Column

Object

データセット列

名前	型	説明
dataCategory	string	任意 この列内のデータを記述するデータ カテゴリに使用する文字列値。
dataType	string	列のデータ型
formatString	string	任意 FORMAT_STRINGで指定されている列の形式。
isHidden	boolean	任意 列が非表示かどうか。 既定値は falseです。
name	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$	列名
sortByColumn	string	任意 現在の列の順序付けに使用する同じテーブル内の列の文字列名。
summarizeBy	string	任意 この列の集計に使用する集計関数。

CreateDatasetRequest

Object

Power BI データセット

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

CrossFilteringBehavior

列挙

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

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

Dataset

Object

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

DatasetMode

列挙

データセット モードまたは型

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

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

Datasource

Object

Power BI データ ソース

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

DatasourceConnectionDetails

Object

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	なし
basicFIFO	basicFIFO

DependentDataflow

Object

Power BI 依存データフロー

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

Encryption

Object

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

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

EncryptionStatus

列挙

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

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

Measure

Object

Power BI メジャー

名前	型	説明
description	string	任意 メジャーの説明。
expression	string	有効な DAX 式
formatString	string	任意 FORMAT_STRINGで指定されているように値を表示する場合の書式設定方法を説明する文字列。
isHidden	boolean	任意 メジャーが非表示かどうか。
name	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$	メジャー名

PrincipalType

列挙

プリンシパルの種類

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

Relationship

Object

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

名前	型	規定値	説明
crossFilteringBehavior	CrossFilteringBehavior	OneDirection	リレーションシップのフィルターの方向
fromColumn	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$		外部キー列の名前
fromTable	string pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$		外部キー テーブルの名前
name	string pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$		リレーションシップの名前と識別子
toColumn	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$		主キー列の名前
toTable	string pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$		主キー テーブルの名前

Row

Object

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

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

ServicePrincipalProfile

Object

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

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

Table

Object

データセット テーブル

名前	型	説明
columns	Column[]	このテーブルの列スキーマ
description	string	テーブルの説明
isHidden	boolean	任意 このデータセット テーブルが非表示かどうか。
measures	Measure[]	この表内のメジャー
name	string pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$	テーブル名
rows	Row[]	このテーブル内のデータ行
source	ASMashupExpression[]	テーブル ソース