Datasets - Refresh Dataset
[マイ ワークスペース] から、指定したデータセットの更新をトリガーします。 拡張更新は、 以外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 パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
dataset
|
path | True |
string |
データセット ID |
要求本文
名前 | 必須 | 型 | 説明 |
---|---|---|---|
notifyOption | True |
メール通知オプション。 このパラメーターは、サービス プリンシパルを使用した拡張更新または API 操作には適用されません。 |
|
applyRefreshPolicy |
boolean |
ポリシーが適用されているかどうかを判断する |
|
commitMode |
オブジェクトがバッチでコミットされるか、完了したときにのみコミットされるかを決定します |
||
effectiveDate |
string |
増分更新ポリシーが適用されている場合、 |
|
maxParallelism |
integer |
並列処理コマンドを実行するスレッドの最大数 |
|
objects |
処理するオブジェクトの配列 |
||
retryCount |
integer |
失敗するまでに操作が再試行される回数 |
|
type |
実行する処理の種類 |
応答
名前 | 型 | 説明 |
---|---|---|
202 Accepted |
同意 Headers
|
例
Example of refreshing a dataset |
Example of refreshing one partition |
Example of refreshing a dataset
Sample Request
POST https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes
Sample Response
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
Sample Request
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"
}
Sample Response
定義
名前 | 説明 |
---|---|
Dataset |
オブジェクトがバッチでコミットされるか、完了したときにのみコミットされるかを決定します |
Dataset |
Power BI データセットの更新ターゲット |
Dataset |
Power BI データセットの更新要求 |
Dataset |
実行する処理の種類 |
Notify |
メール通知オプション |
DatasetCommitMode
オブジェクトがバッチでコミットされるか、完了したときにのみコミットされるかを決定します
名前 | 型 | 説明 |
---|---|---|
PartialBatch |
string |
更新操作をバッチでコミットします。 モードを使用する |
Transactional |
string |
更新操作全体をトランザクションとしてコミットする |
DatasetRefreshObjects
Power BI データセットの更新ターゲット
名前 | 型 | 説明 |
---|---|---|
partition |
string |
更新するパーティション |
table |
string |
更新するテーブル |
DatasetRefreshRequest
Power BI データセットの更新要求
名前 | 型 | 説明 |
---|---|---|
applyRefreshPolicy |
boolean |
ポリシーが適用されているかどうかを判断する |
commitMode |
オブジェクトがバッチでコミットされるか、完了したときにのみコミットされるかを決定します |
|
effectiveDate |
string |
増分更新ポリシーが適用されている場合、 |
maxParallelism |
integer |
並列処理コマンドを実行するスレッドの最大数 |
notifyOption |
メール通知オプション。 このパラメーターは、サービス プリンシパルを使用した拡張更新または API 操作には適用されません。 |
|
objects |
処理するオブジェクトの配列 |
|
retryCount |
integer |
失敗するまでに操作が再試行される回数 |
type |
実行する処理の種類 |
DatasetRefreshType
実行する処理の種類
名前 | 型 | 説明 |
---|---|---|
Automatic |
string |
オブジェクトを更新し、再計算する必要がある場合、オブジェクトとそのすべての依存を更新し、再計算します。 パーティションの状態が準備完了以外の場合に適用されます。 |
Calculate |
string |
必要な場合にのみ、このオブジェクトとそのすべての依存を再計算します。 この値は、揮発性の数式を除き、再計算を強制しません。 |
ClearValues |
string |
このオブジェクトとそのすべての依存オブジェクトの値をクリアする |
DataOnly |
string |
このオブジェクトのデータを更新し、すべての依存をクリアする |
Defragment |
string |
指定されたテーブル内のデータを最適化します。 データがテーブルに追加されるか、テーブルから削除されると、各列のディクショナリに、実際の列値にはもう存在しない値が入力されることがあります。 最適化オプションを利用すると、使用されなくなったディクショナリの値が消去されます。 |
Full |
string |
指定されたパーティション、テーブル、データベースのすべてのパーティションに対して、データが更新され、すべての依存が再計算されます。 計算パーティションに対して、パーティションとそのすべての依存を再計算します。 |
NotifyOption
メール通知オプション
名前 | 型 | 説明 |
---|---|---|
MailOnCompletion |
string |
更新の完了時に成功または失敗を示すメール通知が送信されます |
MailOnFailure |
string |
更新エラー時にメール通知が送信されます |
NoNotification |
string |
通知は送信されません |