通过

Dataflows - Update Refresh Schedule

服务:
Power BI REST APIs
API 版本:
v1.0

为指定的数据流创建或更新刷新计划。

Permissions

此 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

好的

示例

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

枚举

执行刷新的天数

值 说明
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

RefreshSchedule

Object

导入模型的 Power BI 刷新计划

名称 类型 说明
days

days[]

执行刷新的天数
enabled

boolean

是否启用刷新
localTimeZoneId

string

要使用的时区的 ID。 有关详细信息，请参阅 时区信息。
notifyOption

ScheduleNotifyOption

计划刷新终止的通知选项。 服务主体仅支持 NoNotification 该值。
times

string[]

执行刷新的一天中的时间

RefreshScheduleRequest

Object

Power BI 刷新计划请求

名称 类型 说明
value

RefreshSchedule

包含刷新计划详细信息的对象

ScheduleNotifyOption

枚举

计划刷新终止的通知选项。 服务主体仅支持 NoNotification 该值。

值 说明
NoNotification

不会发送通知
MailOnFailure

刷新失败时将发送邮件通知