次の方法で共有

Dataflows - Update Refresh Schedule

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

指定したデータフローの更新スケジュールを作成または更新します。

アクセス許可

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

必要なスコープ

Dataflow.ReadWrite.All

PATCH https://api.powerbi.com/v1.0/myorg/groups/{groupId}/dataflows/{dataflowId}/refreshSchedule

URI パラメーター

名前 / 必須 型 説明
dataflowId
 path True

string

uuid

データフロー ID
groupId
 path True

string

uuid

ワークスペース ID

要求本文

名前 必須 型 説明
value True

RefreshSchedule

更新スケジュールの詳細を含む オブジェクト

応答

名前 型 説明
200 OK

OK

例

Daily refresh schedule example
Disable refresh schedule example
Update refresh schedule times example

Daily refresh schedule example

要求のサンプル

PATCH https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dataflows/928228ba-008d-4fd9-864a-92d2752ee5ce/refreshSchedule
要求本文
{
  "value": {
    "days": [
      "Sunday",
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday",
      "Saturday"
    ],
    "times": [
      "10:00",
      "16:00"
    ],
    "enabled": true,
    "localTimeZoneId": "UTC",
    "notifyOption": "NoNotification"
  }
}

応答のサンプル

状態コード:
200

Disable refresh schedule example

要求のサンプル

PATCH https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dataflows/928228ba-008d-4fd9-864a-92d2752ee5ce/refreshSchedule
要求本文
{
  "value": {
    "enabled": false,
    "times": [],
    "localTimeZoneId": "UTC"
  }
}

応答のサンプル

状態コード:
200

Update refresh schedule times example

要求のサンプル

PATCH https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dataflows/928228ba-008d-4fd9-864a-92d2752ee5ce/refreshSchedule
要求本文
{
  "value": {
    "times": [
      "10:30",
      "16:30"
    ],
    "enabled": true,
    "localTimeZoneId": "UTC"
  }
}

応答のサンプル

状態コード:
200

定義

名前 説明
days

更新を実行する日
RefreshSchedule

インポートされたモデルの Power BI 更新スケジュール
RefreshScheduleRequest

Power BI 更新スケジュール要求
ScheduleNotifyOption

スケジュールされた更新の終了時の通知オプション。 サービス プリンシパルでは、 値のみがサポートされます NoNotification 。

days

Enumeration

更新を実行する日

値 説明
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

RefreshSchedule

Object

インポートされたモデルの Power BI 更新スケジュール

名前 型 説明
days

days[]

更新を実行する日
enabled

boolean

更新が有効になっているかどうか
localTimeZoneId

string

使用するタイム ゾーンの ID。 詳細については、「 タイム ゾーン情報」を参照してください。
notifyOption

ScheduleNotifyOption

スケジュールされた更新の終了時の通知オプション。 サービス プリンシパルでは、 値のみがサポートされます NoNotification 。
times

string[]

更新を実行する時刻

RefreshScheduleRequest

Object

Power BI 更新スケジュール要求

名前 型 説明
value

RefreshSchedule

更新スケジュールの詳細を含む オブジェクト

ScheduleNotifyOption

Enumeration

スケジュールされた更新の終了時の通知オプション。 サービス プリンシパルでは、 値のみがサポートされます NoNotification 。

値 説明
MailOnFailure

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

通知は送信されません