Push Datasets - Datasets PostDataset

Referenz

Service:: Power BI REST APIs

API Version:: v1.0

Erstellt ein neues Dataset in "Mein Arbeitsbereich".

Erforderlicher Bereich

Dataset.ReadWrite.All

Einschränkungen

Dieser API-Aufruf unterstützt nur Pushdatasets. Eine vollständige Liste der Einschränkungen finden Sie unter Einschränkungen für Pushdatasets.

POST https://api.powerbi.com/v1.0/myorg/datasets

With optional parameters:

POST https://api.powerbi.com/v1.0/myorg/datasets?defaultRetentionPolicy={defaultRetentionPolicy}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
defaultRetentionPolicy	query		DefaultRetentionPolicy	Die Standardaufbewahrungsrichtlinie

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
name	True	string	Der Name des Datasets
tables	True	Table[]	Die Datasettabellen
datasources		Datasource[]	Die diesem Dataset zugeordneten Datenquellen
defaultMode		DatasetMode	Der Datasetmodus oder -typ
relationships		Relationship[]	Die Datasetbeziehungen

Antworten

Name	Typ	Beschreibung
201 Created	Dataset	Erstellt
202 Accepted	Dataset	Akzeptiert

Beispiele

Push example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/datasets?defaultRetentionPolicy=basicFIFO

Request Body

{
  "name": "SalesMarketing",
  "defaultMode": "Push",
  "tables": [
    {
      "name": "Product",
      "columns": [
        {
          "name": "ProductID",
          "dataType": "Int64"
        },
        {
          "name": "Name",
          "dataType": "string"
        },
        {
          "name": "Category",
          "dataType": "string"
        },
        {
          "name": "IsCompete",
          "dataType": "bool"
        },
        {
          "name": "ManufacturedOn",
          "dataType": "DateTime"
        },
        {
          "name": "Sales",
          "dataType": "Int64",
          "formatString": "Currency"
        }
      ]
    }
  ]
}

Sample Response

Status code:: 201

{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "name": "SalesMarketing",
  "defaultRetentionPolicy": "basicFIFO"
}

Definitionen

Name	Beschreibung
ASMashupExpression	Eine Datasettabellenquelle
Column	Eine Datasetspalte
CreateDatasetRequest	Ein Power BI-Dataset
CrossFilteringBehavior	Die Filterrichtung der Beziehung
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.
DatasetMode	Der Datasetmodus oder -typ
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)
Datasource	Eine Power BI-Datenquelle
DatasourceConnectionDetails	Die Verbindungsdetails der Power BI-Datenquelle. Beispiele finden Sie unter Abrufen von Datenquellen oder Abrufen von Datenquellen in Gruppe.
DefaultRetentionPolicy	Die Standardaufbewahrungsrichtlinie
DependentDataflow	Ein abhängiger Power BI-Dataflow
Encryption	Verschlüsselungsinformationen für ein Dataset
EncryptionStatus	Datasetverschlüsselung status
Measure	Ein Power BI-Measure
PrincipalType	Der Prinzipaltyp
Relationship	Eine Beziehung zwischen Tabellen in einem Dataset
Row	Eine Datenzeile in einem Dataset
ServicePrincipalProfile	Ein Power BI-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Mehrinstanzenlösung.
Table	Eine Datasettabelle

ASMashupExpression

Eine Datasettabellenquelle

Name	Typ	Beschreibung
expression	string	Der Quellausdruck

Column

Eine Datasetspalte

Name	Typ	Beschreibung
dataCategory	string	Optional. Der Zeichenfolgenwert, der für die Datenkategorie verwendet werden soll, die die Daten in dieser Spalte beschreibt.
dataType	string	Der Spaltendatentyp
formatString	string	Optional. Das Format der Spalte, wie in FORMAT_STRING angegeben.
isHidden	boolean	Optional. Gibt an, ob die Spalte ausgeblendet ist. Der Standardwert ist `false`.
name	string	Der Spaltenname
sortByColumn	string	Optional. Zeichenfolgenname einer Spalte in der gleichen Tabelle, die zum Sortieren der aktuellen Spalte verwendet werden soll.
summarizeBy	string	Dies ist optional. Die Aggregatfunktion, die zum Zusammenfassen dieser Spalte verwendet werden soll.

CreateDatasetRequest

Ein Power BI-Dataset

Name	Typ	Beschreibung
datasources	Datasource[]	Die diesem Dataset zugeordneten Datenquellen
defaultMode	DatasetMode	Der Datasetmodus oder -typ
name	string	Der Name des Datasets
relationships	Relationship[]	Die Datasetbeziehungen
tables	Table[]	Die Datasettabellen

CrossFilteringBehavior

Die Filterrichtung der Beziehung

Name	Typ	Beschreibung
Automatic	string	Kreuzfilterungsverhalten wird automatisch definiert
BothDirections	string	Zu Filterzwecken werden beide Tabellen als eine einzelne Tabelle behandelt.
OneDirection	string	Zu Filterzwecken wird der Filter auf die Tabelle angewendet, in der Die Werte aggregiert werden.

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	Encryption	Datasetverschlüsselungsinformationen. Gilt nur, wenn `$expand` angegeben ist.
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	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) 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 `getArtifactUsers` Parameter verwenden.
webUrl	string	Die Web-URL des Datasets

DatasetMode

Der Datasetmodus oder -typ

Name	Typ	Beschreibung
AsAzure	string	Ein Dataset mit einer Liveverbindung mit Azure Analysis Services
AsOnPrem	string	Ein Dataset mit einer Liveverbindung mit dem lokalen Azure Analysis Services
Push	string	Ein Dataset, das programmgesteuerten Zugriff zum Übertragen von Daten in Power BI ermöglicht
PushStreaming	string	Ein Dataset, das Datenstreaming unterstützt und programmgesteuerten Zugriff zum Übertragen von Daten in Power BI ermöglicht.
Streaming	string	Ein Dataset, das Datenstreaming unterstützt. Weitere Informationen finden Sie unter Echtzeitstreaming in Power BI.

DatasetQueryScaleOutSettings

Abfragen von Horizontalskalierungseinstellungen eines Datasets

Name	Typ	Beschreibung
autoSyncReadOnlyReplicas	boolean	Gibt an, ob das Dataset schreibgeschützte Replikate automatisch 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 Mehrinstanzenlösung.
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 Erneuten Freigabezugriff auf den Inhalt im Dataset
ReadReshareExplore	string	Gewährt Lese-, Freigabe- und Erkundungszugriff 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 freigabezugriff auf den Inhalt im Dataset
ReadWriteReshareExplore	string	Gewährt Lese-, Schreib-, Freigabe- und Erkundungszugriff auf den Inhalt im Dataset.

Datasource

Eine Power BI-Datenquelle

Name	Typ	Beschreibung
connectionDetails	DatasourceConnectionDetails	Details zur Datenquellenverbindung
connectionString	string	(Veraltet) Die Datenquelle Verbindungszeichenfolge. Nur für DirectQuery verfügbar.
datasourceId	string	Die gebundene Datenquellen-ID, die leer ist, wenn sie nicht an ein Gateway gebunden ist
datasourceType	string	Der Datenquellentyp
gatewayId	string	Die gebundene Gateway-ID, die leer ist, wenn sie nicht an ein Gateway gebunden ist. Bei Verwendung eines Gatewayclusters bezieht sich die Gateway-ID auf das primäre (erste) Gateway im Cluster und ähnelt der Gatewaycluster-ID.
name	string	(Veraltet) Der Name der Datenquelle. Nur für DirectQuery verfügbar.

DatasourceConnectionDetails

Die Verbindungsdetails der Power BI-Datenquelle. Beispiele finden Sie unter Abrufen von Datenquellen oder Abrufen von Datenquellen in Gruppe.

Name	Typ	Beschreibung
account	string	Das Verbindungskonto
classInfo	string	Informationen zur Verbindungsklasse
database	string	Die Verbindungsdatenbank
domain	string	Die Verbindungsdomäne
emailAddress	string	Die Verbindungs-E-Mail-Adresse
kind	string	Die Verbindungsart
loginServer	string	Verbindungsanmeldungsserver
path	string	Der Verbindungspfad
server	string	Der Verbindungsserver
url	string	Die Verbindungs-URL

DefaultRetentionPolicy

Die Standardaufbewahrungsrichtlinie

Name	Typ	Beschreibung
None	string	Keine
basicFIFO	string	basicFIFO

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	EncryptionStatus	Datasetverschlüsselung status

EncryptionStatus

Datasetverschlüsselung status

Name	Typ	Beschreibung
InSyncWithWorkspace	string	Die Verschlüsselung wird unterstützt und wird 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.

Measure

Ein Power BI-Measure

Name	Typ	Beschreibung
description	string	Optional. Die Measurebeschreibung.
expression	string	Ein gültiger DAX-Ausdruck
formatString	string	Optional. Eine Zeichenfolge, die beschreibt, wie der Wert formatiert werden soll, wenn er wie in FORMAT_STRING angegeben angezeigt wird.
isHidden	boolean	Optional. Gibt an, ob das Measure ausgeblendet ist.
name	string	Der Measurename

PrincipalType

Der Prinzipaltyp

Name	Typ	Beschreibung
App	string	Dienstprinzipaltyp
Group	string	Gruppenprinzipaltyp
None	string	Kein Prinzipaltyp. Verwenden Sie für den Zugriff auf die gesamte organization ebene.
User	string	Benutzerprinzipaltyp

Relationship

Eine Beziehung zwischen Tabellen in einem Dataset

Name	Typ	Standardwert	Beschreibung
crossFilteringBehavior	CrossFilteringBehavior	OneDirection	Die Filterrichtung der Beziehung
fromColumn	string		Der Name der Fremdschlüsselspalte
fromTable	string		Der Name der Fremdschlüsseltabelle
name	string		Beziehungsname und Bezeichner
toColumn	string		Der Name der Primärschlüsselspalte
toTable	string		Der Name der Primärschlüsseltabelle

Row

Eine Datenzeile in einem Dataset

Name	Typ	Beschreibung
id	string	Die eindeutige Zeilen-ID

ServicePrincipalProfile

Ein Power BI-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Mehrinstanzenlösung.

Name	Typ	Beschreibung
displayName	string	Der Dienstprinzipalprofilname
id	string	Die Dienstprinzipalprofil-ID

Table

Eine Datasettabelle

Name	Typ	Beschreibung
columns	Column[]	Das Spaltenschema für diese Tabelle
description	string	Die Tabellenbeschreibung
isHidden	boolean	Optional. Gibt an, ob diese Datasettabelle ausgeblendet ist.
measures	Measure[]	Die Measures in dieser Tabelle
name	string	Der Tabellenname
rows	Row[]	Die Datenzeilen in dieser Tabelle
source	ASMashupExpression[]	Die Tabellenquelle