Gateways - Create Datasource

Referenz

Service:: Power BI REST APIs

API Version:: v1.0

Erstellt eine neue Datenquelle für das angegebene lokale Gateway.

Lokale Datenquellenanmeldeinformationen müssen verschlüsselt sein. Der encryptedConnection Parameter muss auf Encrypted festgelegt werden, und die Anmeldeinformationen sollten mithilfe des öffentlichen Gatewayschlüssels verschlüsselt werden.

Ein Beispiel für die Verwendung dieser API finden Sie im PowerShell-Skript Erstellen von Gateway dataSource . Dieses Skript verwendet das im folgenden Hinweis erwähnte PowerShell-Skript zum Verschlüsseln der Anmeldeinformationen.

Hinweis

Informationen zum Verschlüsseln von Anmeldeinformationen finden Sie unter Programmgesteuertes Konfigurieren von Anmeldeinformationen für Power BI, und lesen Sie die Beispiele encryptCredentials .NET Core, Java, Python und PowerShell .

Berechtigungen

Unterstützt nur lokale Gateways, und der Benutzer muss über Gatewayadministratorberechtigungen verfügen.

Erforderlicher Bereich

Dataset.ReadWrite.All

Einschränkungen

Virtuelle Netzwerke (VNET) und Cloudgateways werden nicht unterstützt.
OAuth2 als Anmeldeinformationstyp wird nicht unterstützt.

POST https://api.powerbi.com/v1.0/myorg/gateways/{gatewayId}/datasources

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
gatewayId	path	True	string uuid	Die Gateway-ID. Bei Verwendung eines Gatewayclusters bezieht sich die Gateway-ID auf das primäre (erste) Gateway im Cluster. In solchen Fällen ähnelt die Gateway-ID der Gatewaycluster-ID.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
connectionDetails	True	string	Die Verbindungsdetails
credentialDetails	True	CredentialDetails	Die Anmeldeinformationen
dataSourceName	True	string	Der Name der Datenquelle
dataSourceType	True	string	Der Datenquellentyp

Antworten

Name	Typ	Beschreibung
201 Created	GatewayDatasource	Erstellt

Beispiele

Azure Analysis Services example

SQL example

Azure Analysis Services example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/gateways/1f69e798-5852-4fdd-ab01-33bb14b6e934/datasources

Request Body

{
  "dataSourceType": "AnalysisServices",
  "connectionDetails": "{\"server\":\"MyServer\",\"database\":\"MyDatabase\"}",
  "datasourceName": "Sample Datasource",
  "credentialDetails": {
    "credentialType": "Windows",
    "credentials": "AB....EF==",
    "encryptedConnection": "Encrypted",
    "encryptionAlgorithm": "RSA-OAEP",
    "privacyLevel": "None"
  }
}

Sample Response

Status code:: 200

SQL example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/gateways/1f69e798-5852-4fdd-ab01-33bb14b6e934/datasources

Request Body

{
  "dataSourceType": "SQL",
  "connectionDetails": "{\"server\":\"MyServer\",\"database\":\"MyDatabase\"}",
  "datasourceName": "Sample Datasource",
  "credentialDetails": {
    "credentialType": "Windows",
    "credentials": "AB....EF==",
    "encryptedConnection": "Encrypted",
    "encryptionAlgorithm": "RSA-OAEP",
    "privacyLevel": "None"
  }
}

Sample Response

Status code:: 200

Definitionen

Name	Beschreibung
CredentialDetails	Die Anmeldeinformationen
credentialType	Der Typ der Datenquellenanmeldeinformationen
encryptedConnection	Gibt an, ob die Datenquellenverbindung verschlüsselt werden soll. Der API-Aufruf schlägt fehl, wenn Sie Verschlüsselung auswählen und Power BI keine verschlüsselte Verbindung mit der Datenquelle herstellen kann.
encryptionAlgorithm	Der Verschlüsselungsalgorithmus. Geben Sie für eine Clouddatenquelle an `None`. Geben Sie `RSA-OAEP` für eine lokale Datenquelle den öffentlichen Gatewayschlüssel an, und verwenden Sie sie, um die Anmeldeinformationen zu verschlüsseln.
GatewayDatasource	Eine Power BI-Gatewaydatenquelle
GatewayDatasourceCredentialDetails	Details zu den Anmeldeinformationen der Datenquelle
privacyLevel	Die Datenschutzebene, die bei der Kombination von Daten aus mehreren Quellen relevant ist.
PublishDatasourceToGatewayRequest	Eine Veröffentlichungsanforderung für die Datenquelle für das Gateway

CredentialDetails

Die Anmeldeinformationen

Name	Typ	Beschreibung
credentialType	credentialType	Der Anmeldeinformationstyp
credentials	string	Die Anmeldeinformationen, die vom Wert "credentialType" abhängen. Weitere Informationen finden Sie unter Aktualisieren von Datenquellenbeispielen .
encryptedConnection	encryptedConnection	Gibt an, ob die Datenquellenverbindung verschlüsselt werden soll. Der API-Aufruf schlägt fehl, wenn Sie Verschlüsselung auswählen und Power BI keine verschlüsselte Verbindung mit der Datenquelle herstellen kann.
encryptionAlgorithm	encryptionAlgorithm	Der Verschlüsselungsalgorithmus. Geben Sie für eine Clouddatenquelle an `None`. Geben Sie `RSA-OAEP` für eine lokale Datenquelle den öffentlichen Gatewayschlüssel an, und verwenden Sie sie, um die Anmeldeinformationen zu verschlüsseln.
privacyLevel	privacyLevel	Die Datenschutzebene, die bei der Kombination von Daten aus mehreren Quellen relevant ist.
useCallerAADIdentity	boolean	Gibt an, ob die Azure AD-Identität (OAuth 2.0-Anmeldeinformationen) des API-Aufrufers (der der Besitzer der Datenquelle sein muss) zum Konfigurieren von Datenquellenanmeldeinformationen (das OAuth-Zugriffstoken des Besitzers) verwendet wird. In der Regel verwenden Sie entweder dieses Flag oder `useEndUserOAuth2Credentials`.
useEndUserOAuth2Credentials	boolean	Gibt an, ob die Azure AD-Identität des Endbenutzers (OAuth 2.0-Anmeldeinformationen) beim Herstellen einer Verbindung mit der Datenquelle im DirectQuery-Modus verwendet wird. Verwenden Sie mit Datenquellen, die einmaliges Anmelden (Single Sign-On, SSO) unterstützen. In der Regel verwenden Sie entweder dieses Flag oder `useCallerAADIdentity`.

credentialType

Der Typ der Datenquellenanmeldeinformationen

Name	Typ	Beschreibung
Anonymous	string
Basic	string
Key	string
OAuth2	string
SAS	string
Windows	string

encryptedConnection

Gibt an, ob die Datenquellenverbindung verschlüsselt werden soll. Der API-Aufruf schlägt fehl, wenn Sie Verschlüsselung auswählen und Power BI keine verschlüsselte Verbindung mit der Datenquelle herstellen kann.

Name	Typ	Beschreibung
Encrypted	string
NotEncrypted	string

encryptionAlgorithm

Der Verschlüsselungsalgorithmus. Geben Sie für eine Clouddatenquelle an None. Geben Sie RSA-OAEP für eine lokale Datenquelle den öffentlichen Gatewayschlüssel an, und verwenden Sie sie, um die Anmeldeinformationen zu verschlüsseln.

Name	Typ	Beschreibung
None	string
RSA-OAEP	string

GatewayDatasource

Eine Power BI-Gatewaydatenquelle

Name

Typ

Beschreibung

connectionDetails

string

Verbindungsdetails im JSON-Format

credentialDetails

GatewayDatasourceCredentialDetails

Die Verbindungsdetails für die Datenquelle, die aktualisiert werden muss. Die Verbindungsdetails sind obligatorisch, wenn das Dataset über mehrere Datenquellen verfügt.

credentialType

Der Typ der Datenquellenanmeldeinformationen

datasourceName

string

Der Name der Datenquelle.

datasourceType

string

Der Typ der Datenquelle.

API-Name für die Datenquelle
ActiveDirectory	AdobeAnalytics	AdoDotNet
AnalysisServices	AzureBlobs	AzureDataLakeStorage
AzureMarketplace	AzureTables	BizTalk
CDPA	CustomConnector	CustomHttpApi
DB2	Essbase	EventHub
Excel	Exchange	Durchwahl
Facebook	Datei	Ordner
GoogleAnalytics	Hdfs	HDInsight
Informix	MQ	MySQL
OData	ODBC	OLEDB
Oracle	PostgreSQL	PowerQueryMashup
PubNub	Salesforce	SAPBW
SAPBWMessageServer	SapErp	SAPHana
SharePoint	SharePointDocLib	SharePointList
Sql	Sybase	Teradata
UIFlow	Web

gatewayId

string

Die zugeordnete Gateway-ID. Bei Verwendung eines Gatewayclusters bezieht sich die Gateway-ID auf das primäre (erste) Gateway im Cluster und ähnelt der Gatewaycluster-ID.

string

Die eindeutige ID für die Datenquelle

GatewayDatasourceCredentialDetails

Details zu den Anmeldeinformationen der Datenquelle

Name	Typ	Beschreibung
useEndUserOAuth2Credentials	boolean	Gibt an, ob die Azure AD-Identität des Endbenutzers (OAuth 2.0-Anmeldeinformationen) beim Herstellen einer Verbindung mit der Datenquelle im DirectQuery-Modus verwendet wird. Verwenden Sie mit Datenquellen, die einmaliges Anmelden (Single Sign-On, SSO) unterstützen.

privacyLevel

Die Datenschutzebene, die bei der Kombination von Daten aus mehreren Quellen relevant ist.

Name	Typ	Beschreibung
None	string
Organizational	string
Private	string
Public	string

PublishDatasourceToGatewayRequest

Eine Veröffentlichungsanforderung für die Datenquelle für das Gateway

Name	Typ	Beschreibung
connectionDetails	string	Die Verbindungsdetails
credentialDetails	CredentialDetails	Die Anmeldeinformationen
dataSourceName	string	Der Name der Datenquelle
dataSourceType	string	Der Datenquellentyp

Gateways - Create Datasource

Berechtigungen

Erforderlicher Bereich

Einschränkungen

URI-Parameter

Anforderungstext

Antworten

Beispiele

Azure Analysis Services example

Sample Request

Sample Response

SQL example

Sample Request

Sample Response

Definitionen

CredentialDetails

credentialType

encryptedConnection

encryptionAlgorithm

GatewayDatasource

GatewayDatasourceCredentialDetails

privacyLevel

PublishDatasourceToGatewayRequest

Zusätzliche Ressourcen