Datasets - Update Direct Query Refresh Schedule

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

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

要求には、一連の日と時刻 、または 有効な頻度が含まれている必要がありますが、両方は含まれません。 時刻を指定せずに一連の日を選択した場合、Power BI では 1 日あたり既定の 1 回の時刻が使用されます。 頻度を設定すると、日と時刻の設定が自動的に上書きされます。

アクセス許可

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

必要なスコープ

Dataset.ReadWrite.All

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

URI パラメーター

名前 / 必須 型 説明
datasetId
 path True

string

データセット ID

要求本文

名前 必須 型 説明
value True

DirectQueryRefreshSchedule

DirectQuery または LiveConnection の更新スケジュールの詳細を含む オブジェクト

応答

名前 型 説明
200 OK

OK

例

Disable a scheduled refresh example
Set a days and times based schedule example
Set a frequency based schedule example
Update the times of a days and times based schedule example

Disable a scheduled refresh example

Sample Request

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

Sample Response

Status code:
200

Set a days and times based schedule example

Sample Request

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

Sample Response

Status code:
200

Set a frequency based schedule example

Sample Request

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

Sample Response

Status code:
200

Update the times of a days and times based schedule example

Sample Request

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

Sample Response

Status code:
200

定義

名前 説明
days

更新を実行する日
DirectQueryRefreshSchedule

DirectQuery または LiveConnection の Power BI 更新スケジュール。頻度または日と時刻の組み合わせを指定します。
DirectQueryRefreshScheduleRequest

DirectQuery または LiveConnection の Power BI 更新スケジュール要求

days

更新を実行する日

名前 型 説明
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

DirectQueryRefreshSchedule

DirectQuery または LiveConnection の Power BI 更新スケジュール。頻度または日と時刻の組み合わせを指定します。

名前 型 説明
days

days[]

更新を実行する日
frequency

integer

連続する更新の間隔 (分単位)。 サポートされる値は 、15、 30、 60、 120、 および 180 です。
localTimeZoneId

string

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

string[]

更新を実行する時刻

DirectQueryRefreshScheduleRequest

DirectQuery または LiveConnection の Power BI 更新スケジュール要求

名前 型 説明
value

DirectQueryRefreshSchedule

DirectQuery または LiveConnection の更新スケジュールの詳細を含む オブジェクト