Datasets - Update Refresh Schedule

Service:

Power BI REST APIs

API Version:

v1.0

Atualizações o agendamento de atualização para o conjunto de dados especificado de Meu workspace.

Uma solicitação que desabilita o agendamento de atualização não deve conter nenhuma outra alteração.

Pelo menos um dia deve ser especificado. Se nenhum horário for especificado, o Power BI usará uma única hora padrão por dia.

Permissões

O usuário deve ser o proprietário do conjunto de dados.

Escopo necessário

Dataset.ReadWrite.All

Limitações

O limite do número de intervalos de tempo por dia depende se uma capacidade Premium ou Compartilhada é usada.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
datasetId	path	True	string	A ID do conjunto de dados

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

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

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