Datasets - Refresh Dataset

リファレンス

サービス:: Power BI REST APIs

API バージョン:: v1.0

[マイワークスペース]から、指定したデータセット更新をトリガーします。拡張更新は、notifyOption 以外の要求ペイロードが設定されている場合にのみトリガーされます。

必要なスコープ

Dataset.ReadWrite.All

制限

共有容量の場合、スケジュールされた更新を使用して実行された更新を含め、1 日あたり最大 8 つの要求を開始できます。
共有容量の場合、要求本文で指定できるのは notifyOption だけです。
共有容量では、拡張更新はサポートされていません。
強化された更新の場合、notifyOption は必要なく、要求本文から除外する必要があります。ただし、notifyOption 以外の 1 つ以上のパラメーターが必要です。
Premium 容量の場合、1 日あたりの最大要求数は、容量内の使用可能なリソースによってのみ制限されます。使用可能なリソースがオーバーロードされている場合、負荷が軽減されるまで更新は調整されます。調整が 1 時間を超えると、更新は失敗します。

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

URI パラメーター

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

要求本文

名前	必須	型	説明
notifyOption	True	NotifyOption	メール通知オプション。このパラメーターは、サービスプリンシパルを使用した拡張更新または API 操作には適用されません。
applyRefreshPolicy		boolean	ポリシーが適用されているかどうかを判断する
commitMode		DatasetCommitMode	オブジェクトがバッチでコミットされるか、完了したときにのみコミットされるかを決定します
effectiveDate		string (date-time)	増分更新ポリシーが適用されている場合、`effectiveDate` パラメーターは現在の日付をオーバーライドします。
maxParallelism		integer	並列処理コマンドを実行するスレッドの最大数
objects		DatasetRefreshObjects[]	処理するオブジェクトの配列
retryCount		integer	操作が失敗するまでに再試行される回数。このパラメーターが 0 に設定されている場合でも、一時的な内部エラーによって更新の再試行がトリガーされる場合があります。
timeout		string pattern: ^([0-1]?[0-9]\|2[0-3]):[0-5][0-9]:[0-5][0-9]$	`timeout` が指定されている場合、セマンティックモデルでの各データ更新の試行は、そのタイムアウトに従います。 `retryCount` が指定されている場合、1 回の更新要求に複数回の試行が含まれる可能性があるため、合計更新期間が指定されたタイムアウトを超える可能性があることに注意してください。たとえば、`timeout` を 1 時間に設定し、`retryCount` を 2 に設定すると、合計更新時間が最大 3 時間になる可能性があります。ユーザーは、`timeout` を調整して、障害検出を高速化するために更新期間を短縮したり、より複雑なデータ更新のために既定の 5 時間を超えて延長したりできます。ただし、再試行を含む合計更新時間は 24 時間を超えることはできません。
type		DatasetRefreshType	実行する処理の種類

応答

名前	型	説明
202 Accepted		受け入れられるヘッダー x-ms-request-id: string Location: string

名前

型

説明

202 Accepted

受け入れられる

ヘッダー

x-ms-request-id: string
Location: string

例

Example of refreshing a dataset

Example of refreshing one partition

Example of refreshing a dataset

要求のサンプル

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

応答のサンプル

状態コード:: 202

x-ms-request-id: 03f22bb5-2e98-4ae8-8113-329bec3987b1
Location: https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes/03f22bb5-2e98-4ae8-8113-329bec3987b1

Example of refreshing one partition

要求のサンプル

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

要求本文

{
  "type": "full",
  "commitMode": "transactional",
  "objects": [
    {
      "table": "Customer",
      "partition": "Robert"
    }
  ],
  "applyRefreshPolicy": "false",
  "timeout": "05:00:00"
}

応答のサンプル

状態コード:: 200

定義

名前	説明
DatasetCommitMode	オブジェクトがバッチでコミットされるか、完了したときにのみコミットされるかを決定します
DatasetRefreshObjects	Power BI データセットの更新ターゲット
DatasetRefreshRequest	Power BI データセットの更新要求
DatasetRefreshType	実行する処理の種類
NotifyOption	メール通知オプション

DatasetCommitMode

列挙

オブジェクトがバッチでコミットされるか、完了したときにのみコミットされるかを決定します

値説明

PartialBatch

値	説明
PartialBatch	更新操作をバッチでコミットします。 `partialBatch` モードを使用する場合、更新操作はトランザクション内では発生しません。したがって、各コマンドは個別にコミットされ、障害が発生した場合、モデルはデータのサブセットのみが読み込まれるか、テーブルが空の状態になる可能性があります。障害が発生した場合に以前のデータの保持を保証する場合は、`commitMode = transactional.` を使用して操作を実行する必要があります。
Transactional	更新操作全体をトランザクションとしてコミットする

更新操作をバッチでコミットします。 partialBatch モードを使用する場合、更新操作はトランザクション内では発生しません。したがって、各コマンドは個別にコミットされ、障害が発生した場合、モデルはデータのサブセットのみが読み込まれるか、テーブルが空の状態になる可能性があります。障害が発生した場合に以前のデータの保持を保証する場合は、commitMode = transactional. を使用して操作を実行する必要があります。

Transactional

更新操作全体をトランザクションとしてコミットする

DatasetRefreshObjects

Object

Power BI データセットの更新ターゲット

名前	型	説明
partition	string	更新するパーティション
table	string	更新するテーブル

DatasetRefreshRequest

Object

Power BI データセットの更新要求

名前	型	説明
applyRefreshPolicy	boolean	ポリシーが適用されているかどうかを判断する
commitMode	DatasetCommitMode	オブジェクトがバッチでコミットされるか、完了したときにのみコミットされるかを決定します
effectiveDate	string (date-time)	増分更新ポリシーが適用されている場合、`effectiveDate` パラメーターは現在の日付をオーバーライドします。
maxParallelism	integer	並列処理コマンドを実行するスレッドの最大数
notifyOption	NotifyOption	メール通知オプション。このパラメーターは、サービスプリンシパルを使用した拡張更新または API 操作には適用されません。
objects	DatasetRefreshObjects[]	処理するオブジェクトの配列
retryCount	integer	操作が失敗するまでに再試行される回数。このパラメーターが 0 に設定されている場合でも、一時的な内部エラーによって更新の再試行がトリガーされる場合があります。
timeout	string pattern: ^([0-1]?[0-9]\|2[0-3]):[0-5][0-9]:[0-5][0-9]$	`timeout` が指定されている場合、セマンティックモデルでの各データ更新の試行は、そのタイムアウトに従います。 `retryCount` が指定されている場合、1 回の更新要求に複数回の試行が含まれる可能性があるため、合計更新期間が指定されたタイムアウトを超える可能性があることに注意してください。たとえば、`timeout` を 1 時間に設定し、`retryCount` を 2 に設定すると、合計更新時間が最大 3 時間になる可能性があります。ユーザーは、`timeout` を調整して、障害検出を高速化するために更新期間を短縮したり、より複雑なデータ更新のために既定の 5 時間を超えて延長したりできます。ただし、再試行を含む合計更新時間は 24 時間を超えることはできません。
type	DatasetRefreshType	実行する処理の種類

DatasetRefreshType

列挙

実行する処理の種類

値	説明
Automatic	オブジェクトを更新して再計算する必要がある場合は、オブジェクトとそのすべての依存オブジェクトを更新して再計算します。パーティションが準備完了以外の状態の場合に適用されます。
Calculate	必要な場合にのみ、このオブジェクトとそのすべての依存オブジェクトを再計算します。この値は、揮発性の数式を除き、再計算を強制しません。
ClearValues	このオブジェクトとそのすべての依存オブジェクトの値をクリアする
DataOnly	このオブジェクトのデータを更新し、すべての依存オブジェクトをクリアする
Defragment	指定したテーブル内のデータを最適化します。データがテーブルに追加またはテーブルから削除されると、各列のディクショナリが、実際の列の値に存在しなくなった値で汚染される可能性があります。最適化オプションは、使用されなくなったディクショナリ内の値をクリーンアップします。
Full	指定したパーティション、テーブル、またはデータベース内のすべてのパーティションについて、データを更新し、すべての依存を再計算します。計算パーティションの場合は、パーティションとそのすべての依存を再計算します。

NotifyOption

列挙

メール通知オプション

値	説明
MailOnCompletion	更新の完了時に成功または失敗を示すメール通知が送信される
MailOnFailure	更新エラー時にメール通知が送信される
NoNotification	通知は送信されません

次の方法で共有

Datasets - Refresh Dataset

必要なスコープ

制限

URI パラメーター

要求本文

応答

例

Example of refreshing a dataset

要求のサンプル

応答のサンプル

Example of refreshing one partition

要求のサンプル

応答のサンプル

定義

DatasetCommitMode

DatasetRefreshObjects

DatasetRefreshRequest

DatasetRefreshType

NotifyOption