Freigeben über

Dataflows - Update Refresh Schedule

Dienst:
Power BI REST APIs
API-Version:
v1.0

Erstellt oder aktualisiert den Aktualisierungszeitplan für einen angegebenen Datenfluss.

Erlaubnisse

Dieser API-Aufruf kann von einem Dienstprinzipalprofil aufgerufen werden. Weitere Informationen finden Sie unter: Dienstprinzipalprofile in Power BI Embedded.

Erforderlicher Bereich

Dataflow.ReadWrite.All 

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
dataflowId
 path True

string (uuid)

Die Datenfluss-ID
groupId
 path True

string (uuid)

Die Arbeitsbereichs-ID

Anforderungstext

Name Erforderlich Typ Beschreibung
value True

RefreshSchedule

Ein Objekt, das die Details eines Aktualisierungszeitplans enthält

Antworten

Name Typ Beschreibung
200 OK

OKAY

Beispiele

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

Daily refresh schedule example

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
200

Disable refresh schedule example

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
200

Update refresh schedule times example

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
200

Definitionen

Name Beschreibung
days

Die Tage, an denen die Aktualisierung ausgeführt werden soll
RefreshSchedule

Ein Power BI-Aktualisierungszeitplan für importiertes Modell
RefreshScheduleRequest

Power BI-Aktualisierungszeitplananforderung
ScheduleNotifyOption

Die Benachrichtigungsoption beim Beenden einer geplanten Aktualisierung. Dienstprinzipale unterstützen nur den NoNotification Wert.

days

Enumeration

Die Tage, an denen die Aktualisierung ausgeführt werden soll

Wert Beschreibung
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

RefreshSchedule

Objekt

Ein Power BI-Aktualisierungszeitplan für importiertes Modell

Name Typ Beschreibung
days

days[]

Die Tage, an denen die Aktualisierung ausgeführt werden soll
enabled

boolean

Gibt an, ob die Aktualisierung aktiviert ist.
localTimeZoneId

string

Die ID der zu verwendenden Zeitzone. Weitere Informationen finden Sie unter Zeitzoneninformationen.
notifyOption

ScheduleNotifyOption

Die Benachrichtigungsoption beim Beenden einer geplanten Aktualisierung. Dienstprinzipale unterstützen nur den NoNotification Wert.
times

string[]

Die Tageszeiten, um die Aktualisierung auszuführen

RefreshScheduleRequest

Objekt

Power BI-Aktualisierungszeitplananforderung

Name Typ Beschreibung
value

RefreshSchedule

Ein Objekt, das die Details eines Aktualisierungszeitplans enthält

ScheduleNotifyOption

Enumeration

Die Benachrichtigungsoption beim Beenden einer geplanten Aktualisierung. Dienstprinzipale unterstützen nur den NoNotification Wert.

Wert Beschreibung
NoNotification

Es wird keine Benachrichtigung gesendet.
MailOnFailure

Beim Aktualisierungsfehler wird eine E-Mail-Benachrichtigung gesendet.