Freigeben über

Imports - Post Import

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

Erstellt neue Inhalte in Mein Arbeitsbereich.

Ein Beispiel für die Verwendung dieser API finden Sie im Importieren großer Dateien PowerShell-Skripts.

Hinweis

Unterstützte Inhalte:

  • Power BI-PBIX-Dateien
  • JSON-Dateien (.json)
  • Excel-Dateien (.xlsx)
  • Berichtsdefinitionssprachendateien (RDL)
  • Geben Sie zum Importieren einer Datei den Inhaltstyp mehrteiligen/formulardaten in den Anforderungsheadern an, und codieren Sie die Datei als Formulardaten im Anforderungstext.
  • Um die Paginated Reports(.rdl)-Datei zu importieren, schließen Sie die RDL-Dateierweiterung in den namen datasetDisplayName ein, wie paginatedReport.rdlin URI-Parametern beschrieben. Die Dateierweiterung in der datasetDisplayName Datei trägt dazu bei, den Upload von Paginated Report(.rdl File) von anderen Uploads zu unterscheiden.
  • Um eine .xlsx Datei aus OneDrive for Business zu importieren, fügen Sie den Inhaltstyp Application/json- in die Anforderungsheader ein. Schließen Sie ImportInfo- ein, wobei filePath auf den .xlsx Dateipfad im Anforderungstext festgelegt ist.
  • Informationen zum Importieren großer Power BI-PBIX-Dateien, die zwischen 1 GB und 10 GB groß sind, finden Sie unter Erstellen eines temporären Uploadspeicherorts. Dies wird nur für Premium-Kapazitätsarbeitsbereiche unterstützt.
  • Um einen Datenfluss aus einer model.json-Datei zu erstellen, legen Sie datasetDisplayName auf model.jsonfest, wie in URI-Parameternbeschrieben.

Erforderlicher Bereich

Dataset.ReadWrite.All

Einschränkungen

  • Datenflüsse mit Dienstprinzipal werden nicht unterstützt.
  • Das Importieren einer Power BI-PBIX-Datei aus OneDrive wird nicht unterstützt.
  • Das Importieren einer Datei mit einer geschützten Vertraulichkeitsbezeichnung wird für Dienstprinzipale nicht unterstützt. 

POST https://api.powerbi.com/v1.0/myorg/imports?datasetDisplayName={datasetDisplayName}
Mit optionalen Parametern: 
POST https://api.powerbi.com/v1.0/myorg/imports?datasetDisplayName={datasetDisplayName}&nameConflict={nameConflict}&skipReport={skipReport}&overrideReportLabel={overrideReportLabel}&overrideModelLabel={overrideModelLabel}&subfolderObjectId={subfolderObjectId}

URI-Parameter

Name In Erforderlich Typ Beschreibung
datasetDisplayName
 query True

string

Der Anzeigename des Datasets sollte die Dateierweiterung enthalten. Wird beim Importieren aus OneDrive for Business nicht unterstützt.
nameConflict
 query

ImportConflictHandlerMode

Gibt an, was zu tun ist, wenn bereits ein Dataset mit demselben Namen vorhanden ist. Der Standardwert ist Ignore. Für RDL-Dateien Abort und Overwrite sind die einzigen unterstützten Optionen und nicht andere.
overrideModelLabel
 query

boolean

Gibt an, ob die vorhandene Bezeichnung für ein Modell beim erneuten Veröffentlichen einer Power BI-PBIX-Datei überschreiben soll. Der Standardwert des Diensts ist true.
overrideReportLabel
 query

boolean

Gibt an, ob beim erneuten Veröffentlichen einer Power BI-PBIX-Datei die vorhandene Berichtsbezeichnung außer Kraft setzen soll. Der Standardwert des Diensts ist true.
skipReport
 query

boolean

Gibt an, ob der Berichtsimport übersprungen werden soll. Wenn angegeben, muss der Wert truewerden. Wird nur für Power BI-PBIX-Dateien unterstützt.
subfolderObjectId
 query

string (uuid)

Die Unterordner-ID zum Importieren der Datei in den Unterordner.

Anforderungstext

Name Typ Beschreibung
connectionType

connectionType

Der Importverbindungstyp für eine OneDrive for Business-Datei
filePath

string

Der Pfad der zu importierenden OneDrive for Business Excel (.xlsx)-Datei, die absolut oder relativ sein kann. Power BI-PBIX-Dateien werden nicht unterstützt.
fileUrl

string

Die URL der gemeinsamen Zugriffssignatur des temporären BLOB-Speichers, der zum Importieren großer Power BI-PBIX-Dateien zwischen 1 GB und 10 GB größe verwendet wird.

Antworten

Name Typ Beschreibung
200 OK

Import

OKAY
202 Accepted

Import

Angenommen

Beispiele

Import dataflow example
Post import example
Post import with 'skipReport' example

Import dataflow example

Beispielanforderung

POST https://api.powerbi.com/v1.0/myorg/imports?datasetDisplayName=model.json&nameConflict=Abort
Anforderungstext
{
  "value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data name=model.json; filename=model.json Content-Type: application/json [Contents of Model JSON Encoded] --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}

Beispiel für eine Antwort

Statuscode:
202 
{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

Post import example

Beispielanforderung

POST https://api.powerbi.com/v1.0/myorg/imports?datasetDisplayName=MyReport&nameConflict=Ignore
Anforderungstext
{
  "value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}

Beispiel für eine Antwort

Statuscode:
202 
{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

Post import with 'skipReport' example

Beispielanforderung

POST https://api.powerbi.com/v1.0/myorg/imports?datasetDisplayName=MyReport&nameConflict=Ignore&skipReport=True&overrideReportLabel=True&overrideModelLabel=True
Anforderungstext
{
  "value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}

Beispiel für eine Antwort

Statuscode:
202 
{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

Definitionen

Name Beschreibung
connectionType

Der Importverbindungstyp für eine OneDrive for Business-Datei
Dataset

Ein Power BI-Dataset. Die API gibt eine Teilmenge der folgenden Liste der Dataseteigenschaften zurück. Die Teilmenge hängt von der aufgerufenen API, den Aufruferberechtigungen und der Verfügbarkeit der Daten in der Power BI-Datenbank ab.
DatasetQueryScaleOutSettings

Abfrageskalierungseinstellungen eines Datasets
DatasetUser

Ein Power BI-Benutzerzugriff für ein Dataset
DatasetUserAccessRight

Das Zugriffsrecht, das der Benutzer für das Dataset hat (Berechtigungsstufe)
DependentDataflow

Ein abhängiger Power BI-Datenfluss
Encryption

Verschlüsselungsinformationen für ein Dataset
EncryptionStatus

Datensetverschlüsselungsstatus
Import

Das Importobjekt
ImportConflictHandlerMode

Gibt an, was zu tun ist, wenn bereits ein Dataset mit demselben Namen vorhanden ist. Der Standardwert ist Ignore. Für RDL-Dateien Abort und Overwrite sind die einzigen unterstützten Optionen und nicht andere.
ImportInfo

Die Informationen zum Import
PrincipalType

Der Prinzipaltyp
Report

Ein Power BI-Bericht. Die API gibt eine Teilmenge der folgenden Liste der Berichtseigenschaften zurück. Die Teilmenge hängt von der aufgerufenen API, den Aufruferberechtigungen und der Verfügbarkeit von Daten in der Power BI-Datenbank ab.
ReportUser

Ein Power BI-Benutzerzugriffsrecht für einen Bericht
ReportUserAccessRight

Das Zugriffsrecht, das der Benutzer für den Bericht hat (Berechtigungsstufe)
ServicePrincipalProfile

Ein Power BI-Dienstprinzipalprofil. Nur für Power BI Embedded Multi-Mandantenlösungrelevant.
Subscription

Ein E-Mail-Abonnement für ein Power BI-Element (z. B. einen Bericht oder ein Dashboard)
SubscriptionUser

Ein Power BI-E-Mail-Abonnementbenutzer

connectionType

Enumeration

Der Importverbindungstyp für eine OneDrive for Business-Datei

Wert Beschreibung
connect
import

Dataset

Objekt

Ein Power BI-Dataset. Die API gibt eine Teilmenge der folgenden Liste der Dataseteigenschaften zurück. Die Teilmenge hängt von der aufgerufenen API, den Aufruferberechtigungen und der Verfügbarkeit der Daten in der Power BI-Datenbank ab.

Name Typ Beschreibung
ContentProviderType

string

Eine veraltete Eigenschaft, die ignoriert werden soll.
Encryption

Encryption

Datensetverschlüsselungsinformationen. Gilt nur, wenn $expand angegeben wird.
IsEffectiveIdentityRequired

boolean

Gibt an, ob das Dataset eine effektive Identität erfordert, die Sie in einem GenerateToken API-Aufruf senden müssen.
IsEffectiveIdentityRolesRequired

boolean

Gibt an, ob die Sicherheit auf Zeilenebene innerhalb der Power BI-PBIX-Datei definiert ist. Wenn ja, müssen Sie eine Rolle angeben.
IsInPlaceSharingEnabled

boolean

Gibt an, ob das Dataset für externe Benutzer freigegeben werden kann, die in ihrem eigenen Mandanten genutzt werden sollen.
IsOnPremGatewayRequired

boolean

Gibt an, ob für das Dataset ein lokales Datengateway erforderlich ist.
IsRefreshable

boolean

Dieses Feld gibt true zurück, wenn das Dataset kürzlich aktualisiert oder für die automatische Aktualisierung konfiguriert ist, wobei der Verbindungsmodus speziell auf "Import" festgelegt ist. Der Wert gibt false für andere Verbindungsmodi zurück, z. B. "DirectQuery" und "LiveConnection", unabhängig davon, ob das Dataset manuell aktualisiert oder für die automatische Aktualisierung eingerichtet wird.
addRowsAPIEnabled

boolean

Gibt an, ob das Dataset das Hinzufügen neuer Zeilen zulässt.
configuredBy

string

Der Datasetbesitzer
createReportEmbedURL

string

Die Datensatz erstellen Berichtseinbettungs-URL
createdDate

string (date-time)

Datum und Uhrzeit der Datensatzerstellung
description

string

Beschreibung des Datasets
id

string

Die Dataset-ID
name

string

Der Datasetname
qnaEmbedURL

string

Das Dataset Q&Eine Einbettungs-URL
queryScaleOutSettings

DatasetQueryScaleOutSettings

Abfrageskalierungseinstellungen eines Datasets
targetStorageMode

string

Der Datasetspeichermodus
upstreamDataflows

DependentDataflow[]

Die Liste aller Datenflüsse dieses Elements hängt von
users

DatasetUser[]

(Leerer Wert) Die Details des Datasetbenutzerzugriffs. Diese Eigenschaft wird aus der Nutzlastantwort in einer bevorstehenden Version entfernt. Sie können Benutzerinformationen zu einem Power BI-Element (z. B. einem Bericht oder einem Dashboard) abrufen, indem Sie die Get Dataset Users as Admin API oder die PostWorkspaceInfo API mit dem getArtifactUsers Parameter verwenden.
webUrl

string

Die Web-URL des Datasets

DatasetQueryScaleOutSettings

Objekt

Abfrageskalierungseinstellungen eines Datasets

Name Typ Beschreibung
autoSyncReadOnlyReplicas

boolean

Gibt an, ob das Dataset schreibgeschützte Replikate automatisch synchronisiert.
maxReadOnlyReplicas

integer

minimum: -1
maximum: 64

Maximale Anzahl schreibgeschützter Replikate für das Dataset (0-64, -1 für die automatische Anzahl von Replikaten)

DatasetUser

Objekt

Ein Power BI-Benutzerzugriff für ein Dataset

Name Typ Beschreibung
datasetUserAccessRight

DatasetUserAccessRight

Das Zugriffsrecht, das der Benutzer für das Dataset hat (Berechtigungsstufe)
displayName

string

Anzeigename des Prinzipals
emailAddress

string

E-Mail-Adresse des Benutzers
graphId

string

Bezeichner des Prinzipals in Microsoft Graph. Nur für Administrator-APIs verfügbar.
identifier

string

Bezeichner des Prinzipals
principalType

PrincipalType

Der Prinzipaltyp
profile

ServicePrincipalProfile

Ein Power BI-Dienstprinzipalprofil. Nur für Power BI Embedded Multi-Mandantenlösungrelevant.
userType

string

Typ des Benutzers.

DatasetUserAccessRight

Enumeration

Das Zugriffsrecht, das der Benutzer für das Dataset hat (Berechtigungsstufe)

Wert Beschreibung
None

Entfernt die Berechtigung für den Inhalt im Dataset.
Read

Gewährt Lesezugriff auf den Inhalt im Dataset
ReadExplore

Gewährt Lese- und Erkundungszugriff auf den Inhalt im Dataset
ReadReshare

Gewährt Lese- und Freigabezugriff auf den Inhalt im Dataset
ReadReshareExplore

Gewährt Lese-, Freigabe- und Erkunden des Zugriffs auf den Inhalt im Dataset
ReadWrite

Gewährt Lese- und Schreibzugriff auf den Inhalt im Dataset
ReadWriteExplore

Gewährt Lese-, Schreib- und Erkunden des Zugriffs auf den Inhalt im Dataset
ReadWriteReshare

Gewährt Lese-, Schreib- und Freigabezugriff auf den Inhalt im Dataset
ReadWriteReshareExplore

Gewährt Lese-, Schreib-, Refreigabe- und Erkunden des Zugriffs auf den Inhalt im Dataset

DependentDataflow

Objekt

Ein abhängiger Power BI-Datenfluss

Name Typ Beschreibung
groupId

string

Die Zielgruppen-ID
targetDataflowId

string

Die Zieldatenfluss-ID

Encryption

Objekt

Verschlüsselungsinformationen für ein Dataset

Name Typ Beschreibung
EncryptionStatus

EncryptionStatus

Datensetverschlüsselungsstatus

EncryptionStatus

Enumeration

Datensetverschlüsselungsstatus

Wert Beschreibung
InSyncWithWorkspace

Die Verschlüsselung wird unterstützt und wird mit den Verschlüsselungseinstellungen synchronisiert.
NotInSyncWithWorkspace

Verschlüsselung wird unterstützt, aber nicht mit den Verschlüsselungseinstellungen synchronisiert
NotSupported

Die Verschlüsselung wird für dieses Dataset nicht unterstützt.
Unknown

Der Verschlüsselungsstatus ist aufgrund von Datasetbeschädigungen unbekannt.

Import

Objekt

Das Importobjekt

Name Typ Beschreibung
createdDateTime

string (date-time)

Erstellungsdatum und -uhrzeit importieren
datasets

Dataset[]

Die Datasets, die diesem Import zugeordnet sind
id

string (uuid)

Die Import-ID
importState enum:
  • Failed
  • Publishing
  • Succeeded

Der Importuploadstatus
name

string

Der Importname
reports

Report[]

Die diesem Import zugeordneten Berichte
updatedDateTime

string (date-time)

Datum und Uhrzeit der letzten Aktualisierung importieren

ImportConflictHandlerMode

Enumeration

Gibt an, was zu tun ist, wenn bereits ein Dataset mit demselben Namen vorhanden ist. Der Standardwert ist Ignore. Für RDL-Dateien Abort und Overwrite sind die einzigen unterstützten Optionen und nicht andere.

Wert Beschreibung
Abort

Wenn bereits ein Dataset mit demselben Namen vorhanden ist, wird der Importvorgang abgebrochen.
CreateOrOverwrite

Wenn bereits ein Dataset mit demselben Namen vorhanden ist, ersetzt der Importvorgang das vorhandene Dataset durch das neue Dataset. Der Importvorgang schlägt fehl, wenn mehrere Datasets mit demselben Namen vorhanden sind.
GenerateUniqueName

Wenn bereits ein Datenfluss mit demselben Namen vorhanden ist, generiert der Importvorgang einen neuen eindeutigen Namen für den neuen Datenfluss.
Ignore

Wenn bereits ein Dataset mit demselben Namen vorhanden ist, erstellt der Importvorgang ein neues Dataset mit demselben Namen.
Overwrite

Wenn bereits ein Dataset mit demselben Namen vorhanden ist, ersetzt der Importvorgang das vorhandene Dataset durch das neue Dataset. Der Importvorgang schlägt fehl, wenn kein Konflikt vorliegt oder mehrere Datasets mit demselben Namen vorhanden sind.

ImportInfo

Objekt

Die Informationen zum Import

Name Typ Beschreibung
connectionType

connectionType

Der Importverbindungstyp für eine OneDrive for Business-Datei
filePath

string

Der Pfad der zu importierenden OneDrive for Business Excel (.xlsx)-Datei, die absolut oder relativ sein kann. Power BI-PBIX-Dateien werden nicht unterstützt.
fileUrl

string

Die URL der gemeinsamen Zugriffssignatur des temporären BLOB-Speichers, der zum Importieren großer Power BI-PBIX-Dateien zwischen 1 GB und 10 GB größe verwendet wird.

PrincipalType

Enumeration

Der Prinzipaltyp

Wert Beschreibung
App

Dienstprinzipaltyp
Group

Gruppenprinzipaltyp
None

Kein Prinzipaltyp. Wird für den Zugriff auf ganze Organisationsebene verwendet.
User

Benutzerprinzipaltyp

Report

Objekt

Ein Power BI-Bericht. Die API gibt eine Teilmenge der folgenden Liste der Berichtseigenschaften zurück. Die Teilmenge hängt von der aufgerufenen API, den Aufruferberechtigungen und der Verfügbarkeit von Daten in der Power BI-Datenbank ab.

Name Typ Beschreibung
appId

string

Die App-ID, die nur zurückgegeben wird, wenn der Bericht zu einer App gehört
datasetId

string

Die Dataset-ID des Berichts
description

string

Beschreibung des Berichts
embedUrl

string

Die Einbettungs-URL des Berichts
id

string (uuid)

Die Berichts-ID
isOwnedByMe

boolean

Gibt an, ob der aktuelle Benutzer entweder eine Kopie des Berichts ändern oder erstellen kann.
name

string

Der Name des Berichts. App-Berichte beginnen mit dem Präfix [App].
originalReportId

string (uuid)

Die tatsächliche Berichts-ID, wenn der Arbeitsbereich als App veröffentlicht wird.
reportType enum:
  • PaginatedReport
  • PowerBIReport

Der Berichtstyp
subscriptions

Subscription[]

(Leerer Wert) Die Abonnementdetails für ein Power BI-Element (z. B. einen Bericht oder ein Dashboard). Diese Eigenschaft wird aus der Nutzlastantwort in einer bevorstehenden Version entfernt. Sie können Abonnementinformationen für einen Power BI-Bericht abrufen, indem Sie den Abrufen von Berichtsabonnements als Administrator- API-Aufruf verwenden.
users

ReportUser[]

(Leerer Wert) Der Benutzer greift auf Details für einen Power BI-Bericht zu. Diese Eigenschaft wird aus der Nutzlastantwort in einer bevorstehenden Version entfernt. Sie können Benutzerinformationen in einem Power BI-Bericht abrufen, indem Sie die Abrufen von Berichtsbenutzern als Administrator- API-Aufruf oder den PostWorkspaceInfo API-Aufruf mit dem parameter getArtifactUsers verwenden.
webUrl

string

Die Web-URL des Berichts

ReportUser

Objekt

Ein Power BI-Benutzerzugriffsrecht für einen Bericht

Name Typ Beschreibung
displayName

string

Anzeigename des Prinzipals
emailAddress

string

E-Mail-Adresse des Benutzers
graphId

string

Bezeichner des Prinzipals in Microsoft Graph. Nur für Administrator-APIs verfügbar.
identifier

string

Bezeichner des Prinzipals
principalType

PrincipalType

Der Prinzipaltyp
profile

ServicePrincipalProfile

Ein Power BI-Dienstprinzipalprofil. Nur für Power BI Embedded Multi-Mandantenlösungrelevant.
reportUserAccessRight

ReportUserAccessRight

Das Zugriffsrecht, das der Benutzer für den Bericht hat (Berechtigungsstufe)
userType

string

Typ des Benutzers.

ReportUserAccessRight

Enumeration

Das Zugriffsrecht, das der Benutzer für den Bericht hat (Berechtigungsstufe)

Wert Beschreibung
None

Keine Berechtigung für Inhalte im Bericht
Owner

Gewährt Lese-, Schreib- und Freigabezugriff auf Inhalte im Bericht
Read

Gewährt Lesezugriff auf Inhalte im Bericht
ReadCopy

Gewährt Lese- und Kopierzugriff auf Inhalte im Bericht
ReadReshare

Gewährt Lese- und Freigabezugriff auf Inhalte im Bericht
ReadWrite

Gewährt Lese- und Schreibzugriff auf Inhalte im Bericht

ServicePrincipalProfile

Objekt

Ein Power BI-Dienstprinzipalprofil. Nur für Power BI Embedded Multi-Mandantenlösungrelevant.

Name Typ Beschreibung
displayName

string

Der Dienstprinzipalprofilname
id

string (uuid)

Die Dienstprinzipalprofil-ID

Subscription

Objekt

Ein E-Mail-Abonnement für ein Power BI-Element (z. B. einen Bericht oder ein Dashboard)

Name Typ Beschreibung
artifactDisplayName

string

Der Name des abonnierten Power BI-Elements (z. B. ein Bericht oder ein Dashboard)
artifactId

string (uuid)

Die ID des abonnierten Power BI-Elements (z. B. ein Bericht oder ein Dashboard)
artifactType

string

Der Typ des Power BI-Elements (z. B. ein Report, Dashboardoder Dataset)
attachmentFormat

string

Format des Berichts, der im E-Mail-Abonnement angefügt ist
endDate

string (date-time)

Enddatum und -uhrzeit des E-Mail-Abonnements
frequency

string

Die Häufigkeit des E-Mail-Abonnements
id

string (uuid)

Die Abonnement-ID
isEnabled

boolean

Gibt an, ob das E-Mail-Abonnement aktiviert ist.
linkToContent

boolean

Gibt an, ob ein Abonnementlink im E-Mail-Abonnement vorhanden ist.
previewImage

boolean

Gibt an, ob ein Screenshot des Berichts im E-Mail-Abonnement vorhanden ist.
startDate

string (date-time)

Startdatum und -uhrzeit des E-Mail-Abonnements
subArtifactDisplayName

string

Der Seitenname des abonnierten Power BI-Elements, wenn es sich um einen Bericht handelt.
title

string

Der App-Name
users

SubscriptionUser[]

Die Details der einzelnen E-Mail-Abonnenten. Bei Verwendung des Abrufen von Benutzerabonnements als Administrator API-Aufruf ist der zurückgegebene Wert ein leeres Array (NULL). Diese Eigenschaft wird aus der Nutzlastantwort in einer bevorstehenden Version entfernt. Sie können Abonnementinformationen in einem Power BI-Bericht oder -Dashboard abrufen, indem Sie die Abrufen von Berichtsabonnements als Administrator- oder Abrufen von Dashboardabonnements als Administrator API-Aufrufen verwenden.

SubscriptionUser

Objekt

Ein Power BI-E-Mail-Abonnementbenutzer

Name Typ Beschreibung
displayName

string

Anzeigename des Prinzipals
emailAddress

string

E-Mail-Adresse des Benutzers
graphId

string

Bezeichner des Prinzipals in Microsoft Graph. Nur für Administrator-APIs verfügbar.
identifier

string

Bezeichner des Prinzipals
principalType

PrincipalType

Der Prinzipaltyp
profile

ServicePrincipalProfile

Ein Power BI-Dienstprinzipalprofil. Nur für Power BI Embedded Multi-Mandantenlösungrelevant.
userType

string

Typ des Benutzers.