Datasets - Update Refresh Schedule

  • リファレンス
Service:
Power BI REST APIs
API Version:
v1.0

[マイ ワークスペース] から、指定したデータセットの更新スケジュールを更新します。

更新スケジュールを無効にする要求には、他の変更を含めてはいけません。

少なくとも 1 日を指定する必要があります。 時刻が指定されていない場合、Power BI では 1 日あたり既定の 1 回の時刻が使用されます。

アクセス許可

ユーザーはデータセット所有者である必要があります。

必要なスコープ

Dataset.ReadWrite.All

制限事項

1 日あたりのタイム スロット数の制限は、 Premium 容量と共有容量のどちらを使用するかによって異なります。 

PATCH https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}/refreshSchedule

URI パラメーター

名前 / 必須 型 説明
datasetId
 path True

string

データセット ID

要求本文

名前 必須 型 説明
value True

RefreshSchedule

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

応答

名前 型 説明
200 OK

OK

例

Change the days and times of a refresh schedule example
Change the notification option of a refresh schedule example
Disable a scheduled refresh example
Update the times of a refresh schedule example

Change the days and times of a refresh schedule example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshSchedule
Request Body
{
  "value": {
    "days": [
      "Sunday",
      "Tuesday",
      "Friday",
      "Saturday"
    ],
    "times": [
      "07:00",
      "11:30",
      "16:00",
      "23:30"
    ],
    "localTimeZoneId": "UTC"
  }
}

Sample Response

Status code:
200

Change the notification option of a refresh schedule example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshSchedule
Request Body
{
  "value": {
    "notifyOption": "NoNotification"
  }
}

Sample Response

Status code:
200

Disable a scheduled refresh example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshSchedule
Request Body
{
  "value": {
    "enabled": false
  }
}

Sample Response

Status code:
200

Update the times of a refresh schedule example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshSchedule
Request Body
{
  "value": {
    "times": [
      "08:00",
      "16:00"
    ]
  }
}

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

通知は送信されません