Push Datasets - Datasets PostDataset

Dienst:: Power BI REST APIs

API-Version:: v1.0

Erstellt ein neues Dataset für My workspace.

Erforderlicher Bereich

Dataset.ReadWrite.All

Einschränkungen

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

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

Mit optionalen Parametern:

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 Datasetname
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	Angenommen

Beispiele

Push example

Beispielanforderung

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

Anforderungstext

{
  "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"
        }
      ]
    }
  ]
}

Beispiel für eine Antwort

Statuscode:: 201

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

Definitionen

Name	Beschreibung
ASMashupExpression	Eine Datensatztabellenquelle
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	Abfrageskalierungseinstellungen eines Datasets
DatasetUser	Ein Power BI-Benutzerzugriff für ein Dataset
DatasetUserAccessRight	Das Zugriffsrecht, das der Benutzer für das Dataset hat (Berechtigungsstufe)
Datasource	Eine Power BI-Datenquelle
DatasourceConnectionDetails	Die Power BI-Datenquellenverbindungsdetails. Beispiele finden Sie in Get Datasources oder Get Datasources In Group.
DefaultRetentionPolicy	Die Standardaufbewahrungsrichtlinie
DependentDataflow	Ein abhängiger Power BI-Datenfluss
Encryption	Verschlüsselungsinformationen für ein Dataset
EncryptionStatus	Datensetverschlüsselungsstatus
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-Dienstprinzipalprofil. Nur für Power BI Embedded Multi-Mandantenlösungrelevant.
Table	Eine Datasettabelle

ASMashupExpression

Objekt

Eine Datensatztabellenquelle

Name	Typ	Beschreibung
expression	string	Der Quellausdruck

Column

Objekt

Eine Datasetspalte

Name	Typ	Beschreibung
dataCategory	string	Wahlfrei. Der für die Datenkategorie zu verwendende Zeichenfolgenwert, der die Daten in dieser Spalte beschreibt.
dataType	string	Der Spaltendatentyp
formatString	string	Wahlfrei. Das Format der Spalte, wie in FORMAT_STRINGangegeben.
isHidden	boolean	Wahlfrei. Gibt an, ob die Spalte ausgeblendet ist. Der Standardwert ist `false`.
name	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$	Der Spaltenname
sortByColumn	string	Wahlfrei. Zeichenfolgenname einer Spalte in derselben Tabelle, die zum Sortieren der aktuellen Spalte verwendet werden soll.
summarizeBy	string	Wahlfrei. Die Aggregatfunktion, die zum Zusammenfassen dieser Spalte verwendet werden soll.

CreateDatasetRequest

Objekt

Ein Power BI-Dataset

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

CrossFilteringBehavior

Enumeration

Die Filterrichtung der Beziehung

Wert	Beschreibung
OneDirection	Für Filterzwecke wird der Filter auf die Tabelle angewendet, in der Werte aggregiert werden.
BothDirections	Für Filterzwecke werden beide Tabellen als einzelne Tabelle behandelt.
Automatic	Das Verhalten der Kreuzfilterung wird automatisch definiert.

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

DatasetMode

Enumeration

Der Datasetmodus oder -typ

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

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
ReadWrite	Gewährt Lese- und Schreibzugriff auf den Inhalt im Dataset
ReadReshare	Gewährt Lese- und Freigabezugriff auf den Inhalt im Dataset
ReadWriteReshare	Gewährt Lese-, Schreib- und Freigabezugriff auf den Inhalt im Dataset
ReadExplore	Gewährt Lese- und Erkundungszugriff auf den Inhalt im Dataset
ReadReshareExplore	Gewährt Lese-, Freigabe- und Erkunden des Zugriffs auf den Inhalt im Dataset
ReadWriteExplore	Gewährt Lese-, Schreib- und Erkunden des Zugriffs auf den Inhalt im Dataset
ReadWriteReshareExplore	Gewährt Lese-, Schreib-, Refreigabe- und Erkunden des Zugriffs auf den Inhalt im Dataset

Datasource

Objekt

Eine Power BI-Datenquelle

Name	Typ	Beschreibung
connectionDetails	DatasourceConnectionDetails	Details zur Datenquellenverbindung
connectionString	string	(Veraltet) Die Verbindungszeichenfolge der Datenquelle. Nur für DirectQuery verfügbar.
datasourceId	string (uuid)	Die gebundene Datenquellen-ID, die leer ist, wenn sie nicht an ein Gateway gebunden ist
datasourceType	string	Der Datenquellentyp
gatewayId	string (uuid)	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

Objekt

Die Power BI-Datenquellenverbindungsdetails. Beispiele finden Sie in Get Datasources oder Get Datasources In Group.

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

DefaultRetentionPolicy

Enumeration

Die Standardaufbewahrungsrichtlinie

Wert	Beschreibung
None	Nichts
basicFIFO	basicFIFO

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
Unknown	Der Verschlüsselungsstatus ist aufgrund von Datasetbeschädigungen unbekannt.
NotSupported	Die Verschlüsselung wird für dieses Dataset nicht unterstützt.
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

Measure

Objekt

Ein Power BI-Measure

Name	Typ	Beschreibung
description	string	Wahlfrei. Die Measurebeschreibung.
expression	string	Ein gültiger DAX-Ausdruck
formatString	string	Wahlfrei. Eine Zeichenfolge, die beschreibt, wie der Wert formatiert werden soll, wenn er wie in FORMAT_STRINGangegeben angezeigt wird.
isHidden	boolean	Wahlfrei. Gibt an, ob das Measure ausgeblendet ist.
name	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$	Der Measurename

PrincipalType

Enumeration

Der Prinzipaltyp

Wert	Beschreibung
None	Kein Prinzipaltyp. Wird für den Zugriff auf ganze Organisationsebene verwendet.
User	Benutzerprinzipaltyp
Group	Gruppenprinzipaltyp
App	Dienstprinzipaltyp

Relationship

Objekt

Eine Beziehung zwischen Tabellen in einem Dataset

Name	Typ	Standardwert	Beschreibung
crossFilteringBehavior	CrossFilteringBehavior	OneDirection	Die Filterrichtung der Beziehung
fromColumn	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$		Der Name der Fremdschlüsselspalte
fromTable	string pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$		Der Name der Fremdschlüsseltabelle
name	string pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$		Der Beziehungsname und der Bezeichner
toColumn	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$		Der Name der Primärschlüsselspalte
toTable	string pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$		Der Name der Primärschlüsseltabelle

Row

Objekt

Eine Datenzeile in einem Dataset

Name	Typ	Beschreibung
id	string	Die eindeutige Zeilen-ID

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

Table

Objekt

Eine Datasettabelle

Name	Typ	Beschreibung
columns	Column[]	Das Spaltenschema für diese Tabelle
description	string	Die Tabellenbeschreibung
isHidden	boolean	Wahlfrei. Gibt an, ob diese Datasettabelle ausgeblendet ist.
measures	Measure[]	Die Measures in dieser Tabelle
name	string pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$	Der Name der Tabelle
rows	Row[]	Die Datenzeilen in dieser Tabelle
source	ASMashupExpression[]	Die Tabellenquelle

Freigeben über

Push Datasets - Datasets PostDataset

Erforderlicher Bereich

Einschränkungen

URI-Parameter

Anforderungstext

Antworten

Beispiele

Push example

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ASMashupExpression

Column

CreateDatasetRequest

CrossFilteringBehavior

Dataset

DatasetMode

DatasetQueryScaleOutSettings

DatasetUser

DatasetUserAccessRight

Datasource

DatasourceConnectionDetails

DefaultRetentionPolicy

DependentDataflow

Encryption

EncryptionStatus

Measure

PrincipalType

Relationship

Row

ServicePrincipalProfile

Table