Partilhar via

Dataflows - Update Refresh Schedule

Serviço:
Power BI REST APIs
Versão da API:
v1.0

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

Permissions

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

OKEY

Exemplos

Daily refresh schedule example
Disable refresh schedule example
Update refresh schedule times example

Daily refresh schedule example

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
200

Disable refresh schedule example

Solicitação de exemplo

PATCH https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dataflows/928228ba-008d-4fd9-864a-92d2752ee5ce/refreshSchedule
Corpo da solicitação
{
  "value": {
    "enabled": false,
    "times": [],
    "localTimeZoneId": "UTC"
  }
}

Resposta de exemplo

Código de status:
200

Update refresh schedule times example

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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

Enumeração

Os dias em que executar a atualização

Valor Description
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

RefreshSchedule

Objeto

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

Nome Tipo Description
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.
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.
times

string[]

As horas do dia para executar a atualização

RefreshScheduleRequest

Objeto

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

Enumeração

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.

Valor Description
NoNotification

Nenhuma notificação será enviada
MailOnFailure

Uma notificação por email será enviada por falha de atualização