Datasets - Update Refresh Schedule In Group

Service:

Power BI REST APIs

API Version:

v1.0

Updates den Aktualisierungszeitplan für das angegebene Dataset aus dem angegebenen Arbeitsbereich aus.

Eine Anforderung, die den Aktualisierungszeitplan deaktiviert, sollte keine anderen Änderungen enthalten.

Es muss mindestens ein Tag angegeben werden. Wenn keine Zeiten angegeben werden, verwendet Power BI eine standardbasierte Einzelzeit pro Tag.

Berechtigungen

• Der Benutzer muss der Besitzer des Datasets sein.
• Dieser API-Aufruf kann von einem Dienstprinzipalprofil aufgerufen werden. Weitere Informationen finden Sie unter Dienstprinzipalprofile in Power BI Embedded.

Erforderlicher Bereich

Dataset.ReadWrite.All

Einschränkungen

Der Grenzwert für die Anzahl von Zeitfenstern pro Tag hängt davon ab, ob eine Premium- oder Shared-Kapazität verwendet wird.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
datasetId	path	True	string	Die Dataset-ID
groupId	path	True	string uuid	Arbeitsbereich-ID

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
value	True	RefreshSchedule	Ein -Objekt, das die Details eines Aktualisierungszeitplans enthält

Antworten

Name	Typ	Beschreibung
200 OK		OK

Beispiele

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/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/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/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/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/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/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/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshSchedule

Request Body

{
  "value": {
    "times": [
      "08:00",
      "16:00"
    ]
  }
}

Sample Response

Status code:

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	Anforderung des Power BI-Aktualisierungszeitplans
ScheduleNotifyOption	Die Benachrichtigungsoption beim Beenden einer geplanten Aktualisierung. Dienstprinzipale unterstützen nur den NoNotification Wert.

days

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

Name	Typ	Beschreibung
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

RefreshSchedule

Ein Power BI-Aktualisierungszeitplan für importiertes Modell

Name	Typ	Beschreibung
NotifyOption	ScheduleNotifyOption	Die Benachrichtigungsoption beim Beenden einer geplanten Aktualisierung. Dienstprinzipale unterstützen nur den NoNotification Wert.
days	days[]	Die Tage, an denen die Aktualisierung ausgeführt werden soll
enabled	boolean	Ob die Aktualisierung aktiviert ist
localTimeZoneId	string	Die ID der zu verwendenden Zeitzone. Weitere Informationen finden Sie unter Zeitzoneninformationen.
times	string[]	Die Tageszeiten, zu denen die Aktualisierung ausgeführt werden soll

RefreshScheduleRequest

Anforderung des Power BI-Aktualisierungszeitplans

Name	Typ	Beschreibung
value	RefreshSchedule	Ein -Objekt, das die Details eines Aktualisierungszeitplans enthält

ScheduleNotifyOption

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

Name	Typ	Beschreibung
MailOnFailure	string	Bei Einem Aktualisierungsfehler wird eine E-Mail-Benachrichtigung gesendet.
NoNotification	string	Es wird keine Benachrichtigung gesendet.