Dataflows - Update Refresh Schedule

  • Référence
Service:
Power BI REST APIs
API Version:
v1.0

Crée ou met à jour la planification d’actualisation pour un flux de données spécifié.

Autorisations

Cet appel d’API peut être appelé par un profil de principal de service. Pour plus d’informations, consultez Profils de principal de service dans Power BI Embedded.

Étendue requise

Dataflow.ReadWrite.All

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

Paramètres URI

Nom Dans Obligatoire Type Description
dataflowId
 path True

string

uuid

ID de flux de données
groupId
 path True

string

uuid

L’ID de l’espace de travail

Corps de la demande

Nom Obligatoire Type Description
value True

RefreshSchedule

Objet qui contient les détails d’une planification d’actualisation

Réponses

Nom Type Description
200 OK

OK

Exemples

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

Définitions

Nom Description
days

Jours pendant lesquels exécuter l’actualisation
RefreshSchedule

Planification de l’actualisation de Power BI pour le modèle importé
RefreshScheduleRequest

Demande de planification d’actualisation Power BI
ScheduleNotifyOption

Option de notification lors de l’arrêt d’une actualisation planifiée. Les principaux de service prennent uniquement en charge la NoNotification valeur.

days

Jours pendant lesquels exécuter l’actualisation

Nom Type Description
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

RefreshSchedule

Planification de l’actualisation de Power BI pour le modèle importé

Nom Type Description
NotifyOption

ScheduleNotifyOption

Option de notification lors de l’arrêt d’une actualisation planifiée. Les principaux de service prennent uniquement en charge la NoNotification valeur.
days

days[]

Jours pendant lesquels exécuter l’actualisation
enabled

boolean

Indique si l’actualisation est activée
localTimeZoneId

string

ID du fuseau horaire à utiliser. Pour plus d’informations, consultez Informations sur les fuseaux horaires.
times

string[]

Heures de la journée pour exécuter l’actualisation

RefreshScheduleRequest

Demande de planification d’actualisation Power BI

Nom Type Description
value

RefreshSchedule

Objet qui contient les détails d’une planification d’actualisation

ScheduleNotifyOption

Option de notification lors de l’arrêt d’une actualisation planifiée. Les principaux de service prennent uniquement en charge la NoNotification valeur.

Nom Type Description
MailOnFailure

string

Une notification par e-mail est envoyée en cas d’échec d’actualisation
NoNotification

string

Aucune notification ne sera envoyée