次の方法で共有

Datasets - Refresh Dataset In Group

  • リファレンス
サービス:
Power BI REST APIs
API バージョン:
v1.0

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

権限

この API 呼び出しは、サービス プリンシパル プロファイルによって呼び出すことができます。 詳細については、「Power BI Embeddedでのサービス プリンシパル プロファイルの 」を参照してください。

必要なスコープ

Dataset.ReadWrite.All

制限

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

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

URI パラメーター

名前 / 必須 型 説明
datasetId
 path True

string

データセット ID
groupId
 path True

string

uuid

ワークスペース ID

要求本文

名前 必須 型 説明
notifyOption True

NotifyOption

メール通知オプション。 このパラメーターは、サービス プリンシパルを使用した拡張更新または API 操作には適用されません。
applyRefreshPolicy

boolean

ポリシーが適用されているかどうかを判断する
commitMode

DatasetCommitMode

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

string

増分更新ポリシーが適用されている場合、effectiveDate パラメーターは現在の日付をオーバーライドします。
maxParallelism

integer

並列処理コマンドを実行するスレッドの最大数
objects

DatasetRefreshObjects[]

処理するオブジェクトの配列
retryCount

integer

操作が失敗するまでに再試行される回数。 このパラメーターが 0 に設定されている場合でも、一時的な内部エラーによって更新の再試行がトリガーされる場合があります。
type

DatasetRefreshType

実行する処理の種類

応答

名前 型 説明
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/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes
要求本文
{
  "notifyOption": "MailOnFailure",
  "retryCount": 3
}

応答のサンプル

状態コード:
202 
x-ms-request-id: 87f31ef7-1e3a-4006-9b0b-191693e79e9e
Location: https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes/87f31ef7-1e3a-4006-9b0b-191693e79e9e

Example of refreshing one partition

要求のサンプル

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes
要求本文
{
  "type": "full",
  "commitMode": "transactional",
  "objects": [
    {
      "table": "Customer",
      "partition": "Robert"
    }
  ],
  "applyRefreshPolicy": "false"
}

応答のサンプル

状態コード:
200

定義

名前 説明
DatasetCommitMode

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

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

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

実行する処理の種類
NotifyOption

メール通知オプション

DatasetCommitMode

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

名前 型 説明
PartialBatch

string

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

string

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

DatasetRefreshObjects

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

名前 型 説明
partition

string

更新するパーティション
table

string

更新するテーブル

DatasetRefreshRequest

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

名前 型 説明
applyRefreshPolicy

boolean

ポリシーが適用されているかどうかを判断する
commitMode

DatasetCommitMode

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

string

増分更新ポリシーが適用されている場合、effectiveDate パラメーターは現在の日付をオーバーライドします。
maxParallelism

integer

並列処理コマンドを実行するスレッドの最大数
notifyOption

NotifyOption

メール通知オプション。 このパラメーターは、サービス プリンシパルを使用した拡張更新または API 操作には適用されません。
objects

DatasetRefreshObjects[]

処理するオブジェクトの配列
retryCount

integer

操作が失敗するまでに再試行される回数。 このパラメーターが 0 に設定されている場合でも、一時的な内部エラーによって更新の再試行がトリガーされる場合があります。
type

DatasetRefreshType

実行する処理の種類

DatasetRefreshType

実行する処理の種類

名前 型 説明
Automatic

string

オブジェクトを更新して再計算する必要がある場合は、オブジェクトとそのすべての依存オブジェクトを更新して再計算します。 パーティションが準備完了以外の状態の場合に適用されます。
Calculate

string

必要な場合にのみ、このオブジェクトとそのすべての依存オブジェクトを再計算します。 この値は、揮発性の数式を除き、再計算を強制しません。
ClearValues

string

このオブジェクトとそのすべての依存オブジェクトの値をクリアする
DataOnly

string

このオブジェクトのデータを更新し、すべての依存オブジェクトをクリアする
Defragment

string

指定したテーブル内のデータを最適化します。 データがテーブルに追加またはテーブルから削除されると、各列のディクショナリが、実際の列の値に存在しなくなった値で汚染される可能性があります。 最適化オプションは、使用されなくなったディクショナリ内の値をクリーンアップします。
Full

string

指定したパーティション、テーブル、またはデータベース内のすべてのパーティションについて、データを更新し、すべての依存を再計算します。 計算パーティションの場合は、パーティションとそのすべての依存を再計算します。

NotifyOption

メール通知オプション

名前 型 説明
MailOnCompletion

string

更新の完了時に成功または失敗を示すメール通知が送信される
MailOnFailure

string

更新エラー時にメール通知が送信される
NoNotification

string

通知は送信されません