Datasets - Refresh Dataset In Group

  • Referenz
Service:
Power BI REST APIs
API Version:
v1.0

Löst eine Aktualisierung für das angegebene Dataset aus dem angegebenen Arbeitsbereich aus. Eine erweiterte Aktualisierung wird nur ausgelöst, wenn eine andere Anforderungsnutzlast als notifyOption festgelegt ist.

Berechtigungen

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

  • Für freigegebene Kapazitäten können maximal acht Anforderungen pro Tag, einschließlich Aktualisierungen, die mithilfe der geplanten Aktualisierung ausgeführt werden, initiiert werden.
  • Für Freigegebene Kapazitäten kann nur notifyOption im Anforderungstext angegeben werden.
  • Die erweiterte Aktualisierung wird für freigegebene Kapazitäten nicht unterstützt.
  • Für die erweiterte Aktualisierung notifyOption ist nicht erforderlich und muss vom Anforderungstext ausgeschlossen werden. Es sind jedoch mindestens ein Parameter notifyOption erforderlich.
  • Bei Premium-Kapazitäten werden die maximalen Anforderungen pro Tag nur durch die verfügbaren Ressourcen in der Kapazität begrenzt. Wenn verfügbare Ressourcen überlastet sind, werden Aktualisierungen gedrosselt, bis die Last reduziert wird. Die Aktualisierung schlägt fehl, wenn die Drosselung eine Stunde überschreitet. 

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

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
notifyOption True

NotifyOption

Optionen für E-Mail-Benachrichtigungen. Dieser Parameter gilt nicht für erweiterte Aktualisierungen oder API-Vorgänge mit einem Dienstprinzipal.
applyRefreshPolicy

boolean

Ermitteln, ob die Richtlinie angewendet wird oder nicht
commitMode

DatasetCommitMode

Bestimmt, ob Objekte in Batches oder nur nach Abschluss eines Commits ausgeführt werden.
effectiveDate

string

Wenn eine Richtlinie für die inkrementelle Aktualisierung angewendet wird, überschreibt der effectiveDate-Parameter das aktuelle Datum.
maxParallelism

integer

Die maximale Anzahl von Threads, auf denen Parallelverarbeitungsbefehle ausgeführt werden sollen
objects

DatasetRefreshObjects[]

Ein Array von zu verarbeitenden Objekten
retryCount

integer

Anzahl der Wiederholungsversuche des Vorgangs, bevor ein Fehler auftritt
type

DatasetRefreshType

Der Typ der auszuführenden Verarbeitung

Antworten

Name Typ Beschreibung
202 Accepted

Akzeptiert

Headers

  • x-ms-request-id: string
  • Location: string

Beispiele

Example of refreshing a dataset
Example of refreshing one partition

Example of refreshing a dataset

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes
Request Body
{
  "notifyOption": "MailOnFailure",
  "retryCount": 3
}

Sample Response

Status code:
202 
x-ms-request-id: 87f31ef7-1e3a-4006-9b0b-191693e79e9e
Location: https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes/87f31ef7-1e3a-4006-9b0b-191693e79e9e

Example of refreshing one partition

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes
Request Body
{
  "type": "full",
  "commitMode": "transactional",
  "objects": [
    {
      "table": "Customer",
      "partition": "Robert"
    }
  ],
  "applyRefreshPolicy": "false"
}

Sample Response

Status code:
200

Definitionen

Name Beschreibung
DatasetCommitMode

Bestimmt, ob Objekte in Batches oder nur nach Abschluss eines Commits ausgeführt werden.
DatasetRefreshObjects

Aktualisierungsziel für Power BI-Datasets
DatasetRefreshRequest

Aktualisierungsanforderung für Power BI-Datasets
DatasetRefreshType

Der Typ der auszuführenden Verarbeitung
NotifyOption

Optionen für E-Mail-Benachrichtigungen

DatasetCommitMode

Bestimmt, ob Objekte in Batches oder nur nach Abschluss eines Commits ausgeführt werden.

Name Typ Beschreibung
PartialBatch

string

Committen Sie den Aktualisierungsvorgang in Batches. Bei Verwendung des partialBatch Modus tritt der Aktualisierungsvorgang nicht innerhalb einer Transaktion auf. Folglich wird jeder Befehl einzeln committet, und im Falle eines Fehlers kann das Modell in einem Zustand enden, in dem nur eine Teilmenge der Daten geladen wird oder die Tabelle leer bleibt. Wenn Sie im Falle eines Fehlers die Beibehaltung vorheriger Daten garantieren möchten, sollten Sie den Vorgang mit commitMode = transactional.
Transactional

string

Committen des gesamten Aktualisierungsvorgangs als Transaktion

DatasetRefreshObjects

Aktualisierungsziel für Power BI-Datasets

Name Typ Beschreibung
partition

string

Zu aktualisierende Partition
table

string

Zu aktualisierende Tabelle

DatasetRefreshRequest

Aktualisierungsanforderung für Power BI-Datasets

Name Typ Beschreibung
applyRefreshPolicy

boolean

Ermitteln, ob die Richtlinie angewendet wird oder nicht
commitMode

DatasetCommitMode

Bestimmt, ob Objekte in Batches oder nur nach Abschluss eines Commits ausgeführt werden.
effectiveDate

string

Wenn eine Richtlinie für die inkrementelle Aktualisierung angewendet wird, überschreibt der effectiveDate-Parameter das aktuelle Datum.
maxParallelism

integer

Die maximale Anzahl von Threads, auf denen Parallelverarbeitungsbefehle ausgeführt werden sollen
notifyOption

NotifyOption

Optionen für E-Mail-Benachrichtigungen. Dieser Parameter gilt nicht für erweiterte Aktualisierungen oder API-Vorgänge mit einem Dienstprinzipal.
objects

DatasetRefreshObjects[]

Ein Array von zu verarbeitenden Objekten
retryCount

integer

Anzahl der Wiederholungsversuche des Vorgangs, bevor ein Fehler auftritt
type

DatasetRefreshType

Der Typ der auszuführenden Verarbeitung

DatasetRefreshType

Der Typ der auszuführenden Verarbeitung

Name Typ Beschreibung
Automatic

string

Wenn das Objekt aktualisiert und neu berechnet werden muss, werden hiermit das Objekt und alle abhängigen Elemente aktualisiert und neu berechnet. Gilt, wenn die Partition in einem anderen Zustand als „bereit“ ist.
Calculate

string

Hiermit werden dieses Objekt und alle abhängigen Elemente neu berechnet, aber nur, wenn erforderlich. Dieser Wert erzwingt keine Neuberechnung, mit Ausnahme von flüchtigen Formeln.
ClearValues

string

Löschen von Werten in diesem Objekt und allen abhängigen Elementen
DataOnly

string

Aktualisieren von Daten in diesem Objekt und Löschen aller abhängigen Elemente
Defragment

string

Hiermit werden die Daten in der angegebenen Tabelle defragmentiert. Beim Hinzufügen oder Entfernen von Daten zu bzw. aus einer Tabelle verbleiben in den Wörterbüchern für jede Spalte Werte, die nicht mehr in den tatsächlichen Spaltenwerten vorhanden sind. Die Defragmentierung bereinigt die Werte in den Wörterbüchern, die nicht mehr verwendet werden.
Full

string

Hiermit werden für alle Partitionen in der angegebenen Partition, Tabelle oder Datenbank die Daten aktualisiert und alle abhängigen Elemente neu berechnet. Hiermit werden für eine Berechnungspartition die Partition und alle abhängigen Elemente neu berechnet.

NotifyOption

Optionen für E-Mail-Benachrichtigungen

Name Typ Beschreibung
MailOnCompletion

string

Bei Abschluss der Aktualisierung wird eine E-Mail-Benachrichtigung mit dem Hinweis auf Erfolg oder Fehler gesendet.
MailOnFailure

string

Bei Einem Aktualisierungsfehler wird eine E-Mail-Benachrichtigung gesendet.
NoNotification

string

Es wird keine Benachrichtigung gesendet.