Imports - Post Import In Group

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

Erstellt neue Inhalte im angegebenen Arbeitsbereich.

Hinweis

Unterstützte Inhalte:

  • Power BI PBIX-Dateien
  • JSON-Dateien (.json)
  • Excel-Dateien (.xlsx)
  • SQL Server Report Definition Language-Dateien (RDL)
  • Um eine Datei zu importieren, geben Sie den Inhaltstyp multipart/form-data in den Anforderungsheadern an, und codieren Sie die Datei als Formulardaten im Anforderungstext.
  • Um eine RDL-Datei zu importieren, fügen Sie die Dateierweiterung in den von datasetDisplayNameangegebenen Namen ein, wie unter URI-Parameter beschrieben.
  • 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 mit filePath auf den .xlsx Dateipfad im Anforderungstext ein.
  • Informationen zum Importieren großer Power BI-PBIX-Dateien mit einer Größe zwischen 1 GB und 10 GB finden Sie unter Create Temporärer Speicherort für das Hochladen in Gruppe und powerShell-Skript zum Importieren großer Dateien. Dies wird nur für Premium-Kapazitätsarbeitsbereiche unterstützt.
  • Um einen Dataflow aus einer model.json-Datei zu erstellen, legen Sie auf model.json festdatasetDisplayName, wie unter URI-Parameter beschrieben.

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

  • Dataflows mit Dienstprinzipal werden nicht unterstützt.
  • Das Importieren einer Power BI-PBIX-Datei von 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/groups/{groupId}/imports?datasetDisplayName={datasetDisplayName}
With optional parameters: 
POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/imports?datasetDisplayName={datasetDisplayName}&nameConflict={nameConflict}&skipReport={skipReport}&overrideReportLabel={overrideReportLabel}&overrideModelLabel={overrideModelLabel}&subfolderObjectId={subfolderObjectId}

URI-Parameter

Name In Erforderlich Typ Beschreibung
groupId
 path True

string

uuid

Arbeitsbereich-ID
datasetDisplayName
 query True

string

Der Anzeigename des Datasets sollte die Dateierweiterung enthalten. Wird beim Importieren aus OneDrive for Business nicht unterstützt. Zum Importieren oder Erstellen von Dataflows sollte dieser Parameter hartcodiert sein, um model.json.
nameConflict
 query

ImportConflictHandlerMode

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

boolean

Bestimmt, ob die vorhandene Bezeichnung in einem Modell beim erneuten Veröffentlichen einer Pbix-Datei in Power BI überschrieben werden soll. Der Standardwert des Diensts ist true.
overrideReportLabel
 query

boolean

Gibt an, ob die vorhandene Bezeichnung in einem Bericht überschrieben werden soll, wenn eine Power BI-PBIX-Datei erneut veröffentlicht wird. Der Standardwert des Diensts ist true.
skipReport
 query

boolean

Gibt an, ob der Berichtsimport übersprungen werden soll. Wenn das Element angegeben wird, muss der Wert true lauten. 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

Media Types: "application/json", "multipart/form-data"

Name Typ Beschreibung
connectionType

connectionType

Der Importverbindungstyp für eine OneDrive for Business Datei
filePath

string

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

string

Die Shared Access Signature-URL des temporären Blobspeichers, 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

OK
202 Accepted

Import

Akzeptiert

Beispiele

Import dataflow model.json example
Post import example
Post import skip report example

Import dataflow model.json example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/cfafbeb1-8037-4d0c-896e-a46fb27ff229/imports?datasetDisplayName=model.json&nameConflict=Abort&skipReport=True
Request Body
{
  "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--"
}

Sample Response

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

Post import example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/cfafbeb1-8037-4d0c-896e-a46fb27ff229/imports?datasetDisplayName=MyReport&nameConflict=Ignore
Request Body
{
  "value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}

Sample Response

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

Post import skip report example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/cfafbeb1-8037-4d0c-896e-a46fb27ff229/imports?datasetDisplayName=MyReport&nameConflict=Ignore&skipReport=True&overrideReportLabel=True&overrideModelLabel=True
Request Body
{
  "value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}

Sample Response

Status code:
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 API namens, den Aufruferberechtigungen und der Verfügbarkeit der Daten in der Power BI-Datenbank ab.
DatasetQueryScaleOutSettings

Abfragen von Horizontalskalierungseinstellungen eines Datasets
DatasetUser

Ein Power BI-Benutzerzugriffsrechteintrag für ein Dataset
DatasetUserAccessRight

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

Ein power BI-abhängiger Dataflow
Encryption

Verschlüsselungsinformationen für ein Dataset
EncryptionStatus

Datasetverschlüsselung status
Import

Das Importobjekt
ImportConflictHandlerMode

Gibt an, was zu tun ist, wenn bereits ein Dataset mit demselben Namen vorhanden ist. Standardwert: Ignore. Für RDL-Dateien Abort sind und Overwrite die einzigen unterstützten Optionen. Für Dataflow-model.json-Dateien Abort und GenerateUniqueName sind die einzigen unterstützten Optionen.
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 API namens, den Aufruferberechtigungen und der Verfügbarkeit von Daten in der Power BI-Datenbank ab.
ReportUser

Ein Power BI-Benutzerzugriffsrechteintrag für einen Bericht
ReportUserAccessRight

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

Ein Power BI-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Lösung mit mehreren Mandanten.
Subscription

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

Ein Power BI-E-Mail-Abonnementbenutzer

connectionType

Der Importverbindungstyp für eine OneDrive for Business Datei

Name Typ Beschreibung
connect

string

import

string

Dataset

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

Name Typ Beschreibung
ContentProviderType

string

Der Inhaltsanbietertyp für das Dataset
CreateReportEmbedURL

string

Einbettungs-URL zum Erstellen eines Berichts im Dataset
CreatedDate

string

Datum und Uhrzeit der Dataseterstellung
Encryption

Encryption

Datasetverschlü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 in der Pbix-Datei von Power BI definiert ist. Wenn ja, müssen Sie eine Rolle angeben.
IsInPlaceSharingEnabled

boolean

Gibt an, ob das Dataset für externe Benutzer freigegeben werden kann, um es in ihrem eigenen Mandanten zu verwenden
IsOnPremGatewayRequired

boolean

Ob das Dataset ein lokales Datengateway erfordert
IsRefreshable

boolean

Gibt an, ob das Dataset aktualisiert werden kann oder nicht. Ein aktualisierbares Power BI-Dataset ist ein Dataset, das mindestens einmal aktualisiert wurde oder für das ein gültiger Aktualisierungszeitplan vorhanden ist.
QnaEmbedURL

string

Das Dataset Q&A Einbettungs-URL
addRowsAPIEnabled

boolean

Ob das Dataset das Hinzufügen neuer Zeilen zulässt
configuredBy

string

Der Datasetbesitzer
description

string

Beschreibung des Datasets
id

string

Die Dataset-ID
name

string

Der Datasetname
queryScaleOutSettings

DatasetQueryScaleOutSettings

Abfragen von Horizontalskalierungseinstellungen eines Datasets
targetStorageMode

string

Der Datasetspeichermodus
upstreamDataflows

DependentDataflow[]

Die Liste aller Dataflows, von der dieses Element abhängt
users

DatasetUser[]

(Leerer Wert) Die Details des Datasetbenutzerzugriffs. Diese Eigenschaft wird in einer bevorstehenden Version aus der Nutzlastantwort 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

Abfragen von Horizontalskalierungseinstellungen eines Datasets

Name Typ Beschreibung
autoSyncReadOnlyReplicas

boolean

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

integer

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

DatasetUser

Ein Power BI-Benutzerzugriffsrechteintrag 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-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Lösung mit mehreren Mandanten.
userType

string

Typ des Benutzers.

DatasetUserAccessRight

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

Name Typ Beschreibung
None

string

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

string

Gewährt Lesezugriff auf den Inhalt im Dataset
ReadExplore

string

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

string

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

string

Gewährt Lese-, Freigabe- und Erkundenzugriff auf den Inhalt im Dataset
ReadWrite

string

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

string

Gewährt Lese-, Schreib- und Erkundungszugriff auf den Inhalt im Dataset
ReadWriteReshare

string

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

string

Gewährt Lese-, Schreib-, Weiterfreigabe- und Erkundenzugriff auf den Inhalt im Dataset

DependentDataflow

Ein power BI-abhängiger Dataflow

Name Typ Beschreibung
groupId

string

Die Zielgruppen-ID
targetDataflowId

string

Die Zieldatenfluss-ID

Encryption

Verschlüsselungsinformationen für ein Dataset

Name Typ Beschreibung
EncryptionStatus

EncryptionStatus

Datasetverschlüsselung status

EncryptionStatus

Datasetverschlüsselung status

Name Typ Beschreibung
InSyncWithWorkspace

string

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

string

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

string

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

string

Die Verschlüsselung status ist aufgrund einer Datasetbeschädigung unbekannt.

Import

Das Importobjekt

Name Typ Beschreibung
createdDateTime

string

Datum und Uhrzeit der Erstellung importieren
datasets

Dataset[]

Die datasets, die diesem Import zugeordnet sind
id

string

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

Der Importuploadstatus
name

string

Der Importname
reports

Report[]

Die diesem Import zugeordneten Berichte
updatedDateTime

string

Importieren von Datum und Uhrzeit der letzten Aktualisierung

ImportConflictHandlerMode

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

Name Typ Beschreibung
Abort

string

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

string

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

string

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

string

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

string

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 wenn mehrere Datasets mit demselben Namen vorhanden sind.

ImportInfo

Die Informationen zum Import

Name Typ Beschreibung
connectionType

connectionType

Der Importverbindungstyp für eine OneDrive for Business Datei
filePath

string

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

string

Die Shared Access Signature-URL des temporären Blobspeichers, der zum Importieren großer Power BI-PBIX-Dateien zwischen 1 GB und 10 GB größe verwendet wird.

PrincipalType

Der Prinzipaltyp

Name Typ Beschreibung
App

string

Dienstprinzipaltyp
Group

string

Gruppenprinzipaltyp
None

string

Kein Prinzipaltyp. Verwenden Sie für den Zugriff auf organization ganzen Organization ebene.
User

string

Benutzerprinzipaltyp

Report

ein Power BI-Bericht Die API gibt eine Teilmenge der folgenden Liste der Berichtseigenschaften zurück. Die Teilmenge hängt von der API namens, 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

Die Berichts-ID
isOwnedByMe

boolean

Ermitteln Sie, ob der Bericht vom aktuellen Benutzer erstellt wird.
name

string

Der Name des Berichts
originalReportId

string

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 eine Dashboard). Diese Eigenschaft wird in einer bevorstehenden Version aus der Nutzlastantwort entfernt. Sie können Abonnementinformationen für einen Power BI-Bericht abrufen, indem Sie berichtsabonnements abrufen als Admin API-Aufruf verwenden.
users

ReportUser[]

(Leerer Wert) Die Benutzerzugriffsdetails für einen Power BI-Bericht. Diese Eigenschaft wird in einer bevorstehenden Version aus der Nutzlastantwort entfernt. Sie können Benutzerinformationen für einen Power BI-Bericht abrufen, indem Sie berichtsbenutzer als Admin API-Aufruf oder den PostWorkspaceInfo-API-Aufruf mit dem getArtifactUsers Parameter verwenden.
webUrl

string

Die Web-URL des Berichts

ReportUser

Ein Power BI-Benutzerzugriffsrechteintrag 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-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Lösung mit mehreren Mandanten.
reportUserAccessRight

ReportUserAccessRight

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

string

Typ des Benutzers.

ReportUserAccessRight

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

Name Typ Beschreibung
None

string

Keine Berechtigung für Inhalte im Bericht
Owner

string

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

string

Gewährt Lesezugriff auf Inhalte im Bericht
ReadCopy

string

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

string

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

string

Gewährt Lese- und Schreibzugriff auf Inhalte im Bericht

ServicePrincipalProfile

Ein Power BI-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Lösung mit mehreren Mandanten.

Name Typ Beschreibung
displayName

string

Der Dienstprinzipalprofilname
id

string

Die Dienstprinzipalprofil-ID

Subscription

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

Name Typ Beschreibung
artifactDisplayName

string

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

string

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

string

Der Typ des Power BI-Elements (z. B. , ReportDashboardoder Dataset)
attachmentFormat

string

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

string

Enddatum und -uhrzeit des E-Mail-Abonnements
frequency

string

Häufigkeit des E-Mail-Abonnements
id

string

Die Abonnement-ID
isEnabled

boolean

Ob das E-Mail-Abonnement aktiviert ist
linkToContent

boolean

Ob ein Abonnementlink im E-Mail-Abonnement vorhanden ist
previewImage

boolean

Ob ein Screenshot des Berichts im E-Mail-Abonnement vorhanden ist
startDate

string

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. Wenn Sie den API-Aufruf "Benutzerabonnements abrufen als Admin" verwenden, ist der zurückgegebene Wert ein leeres Array (NULL). Diese Eigenschaft wird in einer bevorstehenden Version aus der Nutzlastantwort entfernt. Sie können Abonnementinformationen für einen Power BI-Bericht oder Dashboard abrufen, indem Sie die API-Aufrufe Berichtsabonnements abrufen als Admin oder Dashboardabonnements abrufen als Admin verwenden.

SubscriptionUser

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-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Lösung mit mehreren Mandanten.
userType

string

Typ des Benutzers.