Share via

Dataflows - Update Refresh Schedule

  • Referência
Service:
Power BI REST APIs
API Version:
v1.0

Cria ou atualiza o agendamento de atualização para um fluxo de dados especificado.

Permissões

Essa chamada à API pode ser chamada por um perfil de entidade de serviço. Para obter mais informações, consulte: Perfis de entidade de serviço no Power BI Embedded.

Escopo necessário

Dataflow.ReadWrite.All

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
dataflowId
 path True

string

uuid

A ID do fluxo de dados
groupId
 path True

string

uuid

A ID do workspace

Corpo da solicitação

Nome Obrigatório Tipo Description
value True

RefreshSchedule

Um objeto que contém os detalhes de um agendamento de atualização

Respostas

Nome Tipo Description
200 OK

OK

Exemplos

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

Definições

Nome Description
days

Os dias em que executar a atualização
RefreshSchedule

Um agendamento de atualização do Power BI para o modelo importado
RefreshScheduleRequest

Solicitação de agendamento de atualização do Power BI
ScheduleNotifyOption

A opção de notificação no encerramento de uma atualização agendada. As entidades de serviço só dão suporte ao NoNotification valor .

days

Os dias em que executar a atualização

Nome Tipo Description
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

RefreshSchedule

Um agendamento de atualização do Power BI para o modelo importado

Nome Tipo Description
NotifyOption

ScheduleNotifyOption

A opção de notificação no encerramento de uma atualização agendada. As entidades de serviço só dão suporte ao NoNotification valor .
days

days[]

Os dias em que executar a atualização
enabled

boolean

Se a atualização está habilitada
localTimeZoneId

string

A ID do fuso horário a ser usado. Para obter mais informações, consulte Informações de fuso horário.
times

string[]

As horas do dia para executar a atualização

RefreshScheduleRequest

Solicitação de agendamento de atualização do Power BI

Nome Tipo Description
value

RefreshSchedule

Um objeto que contém os detalhes de um agendamento de atualização

ScheduleNotifyOption

A opção de notificação no encerramento de uma atualização agendada. As entidades de serviço só dão suporte ao NoNotification valor .

Nome Tipo Description
MailOnFailure

string

Uma notificação por email será enviada em caso de falha na atualização
NoNotification

string

Nenhuma notificação será enviada