Dataflows - Update Refresh Schedule

  • リファレンス
Service:
Power BI REST APIs
API Version:
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

Sample Request

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

Sample Response

Status code:
200

Disable refresh schedule example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dataflows/928228ba-008d-4fd9-864a-92d2752ee5ce/refreshSchedule
Request Body
{
  "value": {
    "enabled": false
  }
}

Sample Response

Status code:
200

Update refresh schedule times example

Sample Request

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

Sample Response

Status code:
200

定義

名前 説明
days

更新を実行する日
RefreshSchedule

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

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

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

days

更新を実行する日

名前 型 説明
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

RefreshSchedule

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

名前 型 説明
NotifyOption

ScheduleNotifyOption

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

days[]

更新を実行する日
enabled

boolean

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

string

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

string[]

更新を実行する時刻

RefreshScheduleRequest

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

名前 型 説明
value

RefreshSchedule

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

ScheduleNotifyOption

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

名前 型 説明
MailOnFailure

string

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

string

通知は送信されません