Imports - Get Import In Group
Gibt den angegebenen Import aus dem angegebenen Arbeitsbereich zurück.
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 oder Dataset.Read.All
GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/imports/{importId}
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
group
|
path | True |
string uuid |
Arbeitsbereich-ID |
import
|
path | True |
string uuid |
Die Import-ID |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
OK |
Beispiele
Completed import example |
In-progress import example |
Completed import example
Sample Request
GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/imports/82d9a37a-2b45-4221-b012-cb109b8e30c7
Sample Response
{
"id": "82d9a37a-2b45-4221-b012-cb109b8e30c7",
"importState": "Succeeded",
"createdDateTime": "2018-05-08T14:56:18.477Z",
"updatedDateTime": "2018-05-08T14:56:18.477Z",
"name": "SalesMarketing",
"connectionType": "import",
"source": "Upload",
"datasets": [
{
"id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"name": "SalesMarketing",
"webUrl": "https://app.powerbi.com/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}
],
"reports": [
{
"id": "5b218778-e7a5-4d73-8187-f10824047715",
"name": "SalesMarketing",
"webUrl": "https://app.powerbi.com/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/reports/5b218778-e7a5-4d73-8187-f10824047715",
"embedUrl": "https://app.powerbi.com/reportEmbed?reportId=5b218778-e7a5-4d73-8187-f10824047715&groupId=f089354e-8366-4e18-aea3-4cb4a3a50b48"
}
]
}
In-progress import example
Sample Request
GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/imports/82d9a37a-2b45-4221-b012-cb109b8e30c7
Sample Response
{
"id": "82d9a37a-2b45-4221-b012-cb109b8e30c7",
"importState": "Publishing",
"createdDateTime": "2018-05-08T14:56:18.477Z",
"updatedDateTime": "2018-05-08T14:56:18.477Z",
"name": "SalesMarketing",
"connectionType": "import",
"source": "Upload",
"datasets": [],
"reports": []
}
Definitionen
Name | Beschreibung |
---|---|
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. |
Dataset |
Abfragen von Horizontalskalierungseinstellungen eines Datasets |
Dataset |
Ein Power BI-Benutzerzugriffsrechteintrag für ein Dataset |
Dataset |
Das Zugriffsrecht, das der Benutzer für das Dataset hat (Berechtigungsstufe) |
Dependent |
Ein abhängiger Power BI-Dataflow |
Encryption |
Verschlüsselungsinformationen für ein Dataset |
Encryption |
Datasetverschlüsselung status |
Import |
Das Importobjekt |
Principal |
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. |
Report |
Ein Power BI-Benutzerzugriffsrechteintrag für einen Bericht |
Report |
Das Zugriffsrecht, das der Benutzer für den Bericht hat (Berechtigungsstufe) |
Service |
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) |
Subscription |
Ein Power BI-E-Mail-Abonnementbenutzer |
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.
Name | Typ | Beschreibung |
---|---|---|
ContentProviderType |
string |
Der Inhaltsanbietertyp für das Dataset |
CreateReportEmbedURL |
string |
Einbettungs-URL für die Berichtserstellung für Datasets |
CreatedDate |
string |
Datum und Uhrzeit der Dataseterstellung |
Encryption |
Datasetverschlüsselungsinformationen. Gilt nur, wenn |
|
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, die in ihrem eigenen Mandanten verwendet werden sollen. |
IsOnPremGatewayRequired |
boolean |
Ob das Dataset ein lokales Datengateway erfordert |
IsRefreshable |
boolean |
Gibt an, ob das Dataset aktualisierbar ist 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 |
Die Q&A-Einbettungs-URL des Datasets |
addRowsAPIEnabled |
boolean |
Ob das Dataset das Hinzufügen neuer Zeilen zulässt |
configuredBy |
string |
Der Besitzer des Datasets |
description |
string |
Die Beschreibung des Datasets |
id |
string |
Die Dataset-ID |
name |
string |
Der Name des Datasets |
queryScaleOutSettings |
Abfragen von Horizontalskalierungseinstellungen eines Datasets |
|
targetStorageMode |
string |
Der Datasetspeichermodus |
upstreamDataflows |
Die Liste aller Dataflows, von der dieses Element abhängt |
|
users |
(Leerer Wert) Details zum Benutzerzugriff des Datasets. Diese Eigenschaft wird in einem bevorstehenden Release aus der Nutzlastantwort entfernt. Sie können Benutzerinformationen für ein Power BI-Element (z. B. einen Bericht oder eine Dashboard) abrufen, indem Sie die API zum Abrufen von Datasetbenutzern als Admin oder die PostWorkspaceInfo-API mit dem |
|
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 |
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 |
Der Prinzipaltyp |
|
profile |
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 abhängiger Power BI-Dataflow
Name | Typ | Beschreibung |
---|---|---|
groupId |
string |
Die Zielgruppen-ID |
targetDataflowId |
string |
Die Ziel-Dataflow-ID |
Encryption
Verschlüsselungsinformationen für ein Dataset
Name | Typ | Beschreibung |
---|---|---|
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 Importerstellung |
datasets |
Dataset[] |
Die datasets, die diesem Import zugeordnet sind |
id |
string |
Die Import-ID |
importState |
enum:
|
Importuploadstatus |
name |
string |
Der Importname |
reports |
Report[] |
Die diesem Import zugeordneten Berichte |
updatedDateTime |
string |
Datum und Uhrzeit der letzten Aktualisierung importieren |
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 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 |
Die Berichtsbeschreibung |
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:
|
Der Berichtstyp |
subscriptions |
(Leerer Wert) Die Abonnementdetails für ein Power BI-Element (z. B. einen Bericht oder eine Dashboard). Diese Eigenschaft wird in einem bevorstehenden Release aus der Nutzlastantwort entfernt. Sie können Abonnementinformationen für einen Power BI-Bericht abrufen, indem Sie den API-Aufruf Zum Abrufen von Berichtsabonnements als Admin verwenden. |
|
users |
(Leerer Wert) Die Benutzerzugriffsdetails für einen Power BI-Bericht. Diese Eigenschaft wird in einem bevorstehenden Release aus der Nutzlastantwort entfernt. Sie können Benutzerinformationen für einen Power BI-Bericht abrufen, indem Sie den Aufruf "Berichtsbenutzer als Admin API abrufen" oder den API-Aufruf PostWorkspaceInfo mit dem |
|
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 |
Der Prinzipaltyp |
|
profile |
Ein Power BI-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Mehrinstanzenlösung. |
|
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. , |
attachmentFormat |
string |
Format des Berichts, der im E-Mail-Abonnement angefügt ist |
endDate |
string |
Enddatum und -uhrzeit des E-Mail-Abonnements |
frequency |
string |
Die 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 |
Die Details jedes E-Mail-Abonnenten. Wenn Sie den API-Aufruf Get User Subscriptions As Admin verwenden, ist der zurückgegebene Wert ein leeres Array (NULL). Diese Eigenschaft wird in einem bevorstehenden Release aus der Nutzlastantwort entfernt. Sie können Abonnementinformationen zu einem Power BI-Bericht oder Dashboard abrufen, indem Sie die API-Aufrufe "Berichtsabonnements als Admin abrufen" oder "Dashboardabonnements als Admin abrufen" 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 |
Der Prinzipaltyp |
|
profile |
Ein Power BI-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Lösung mit mehreren Mandanten. |
|
userType |
string |
Typ des Benutzers. |