Gateways - Create Datasource

Dienst:: Power BI REST APIs

API-Version:: v1.0

Erstellt eine neue Datenquelle auf dem angegebenen lokalen Gateway.

Lokale Datenquellenanmeldeinformationen müssen verschlüsselt werden. Der parameter encryptedConnection muss auf Encrypted festgelegt werden, und die Anmeldeinformationen sollten mit dem öffentlichen Gatewayschlüssel verschlüsselt werden.

Ein Beispiel für die Verwendung dieser API finden Sie im Erstellen von Gateway DataSource PowerShell-Skript, das in der nachstehenden Notiz erwähnte PowerShell-Skript zum Verschlüsseln der Anmeldeinformationen verwendet.

Hinweis

Informationen zum Verschlüsseln von Anmeldeinformationen finden Sie unter Programmgesteuerte s Konfigurieren von Anmeldeinformationen für Power BI und überprüfen Sie die Beispiele .NET Core-, Java-, Python- und PowerShell-.

Erlaubnisse

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

Erforderlicher Bereich

Dataset.ReadWrite.All

Einschränkungen

Virtuelles Netzwerk (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

Beispielanforderung

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

Anforderungstext

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

Beispiel für eine Antwort

Statuscode:: 200

SQL example

Beispielanforderung

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

Anforderungstext

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

Beispiel für eine Antwort

Statuscode:: 200

Definitionen

Name	Beschreibung
CredentialDetails	Die Anmeldeinformationen
credentialType	Der Typ der Datenquelle Anmeldeinformationen
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 `None`an. Geben Sie für eine lokale Datenquelle `RSA-OAEP` an, und verwenden Sie den öffentlichen Gatewayschlüssel, um die Anmeldeinformationen zu verschlüsseln.
GatewayDatasource	Eine Power BI-Gatewaydatenquelle
GatewayDatasourceCredentialDetails	Die Details der Datenquellenanmeldeinformationen
privacyLevel	Die Datenschutzstufe, die beim Kombinieren von Daten aus mehreren Quellen relevant ist.
PublishDatasourceToGatewayRequest	Eine Veröffentlichungsdatenquelle für Gatewayanforderung

CredentialDetails

Objekt

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 Datenquellen Beispielen.
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 `None`an. Geben Sie für eine lokale Datenquelle `RSA-OAEP` an, und verwenden Sie den öffentlichen Gatewayschlüssel, um die Anmeldeinformationen zu verschlüsseln.
privacyLevel	privacyLevel	Die Datenschutzstufe, die beim Kombinieren 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 Datenquellenbesitzer sein muss) zum Konfigurieren von Datenquellenanmeldeinformationen (dem OAuth-Zugriffstoken des Besitzers) verwendet wird. In der Regel würden Sie dieses Flag oder `useEndUserOAuth2Credentials`verwenden.
useEndUserOAuth2Credentials	boolean	Gibt an, ob die Azure AD-Identität (OAuth 2.0-Anmeldeinformationen) des Endbenutzers beim Herstellen einer Verbindung mit der Datenquelle im DirectQuery-Modus verwendet wird. Wird mit Datenquellen verwendet, die einmaliges Anmelden (Single Sign-On, SSO)unterstützen. In der Regel würden Sie dieses Flag oder `useCallerAADIdentity`verwenden.

credentialType

Enumeration

Der Typ der Datenquelle Anmeldeinformationen

Wert	Beschreibung
Basic
Windows
Anonymous
OAuth2
Key
SAS

encryptedConnection

Enumeration

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.

Wert	Beschreibung
Encrypted
NotEncrypted

encryptionAlgorithm

Enumeration

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

Wert	Beschreibung
None
RSA-OAEP

GatewayDatasource

Objekt

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 mehr als eine Datenquelle aufweist.

credentialType

Der Typ der Datenquelle Anmeldeinformationen

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	Umtausch	Erweiterung
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	das Internet

gatewayId

string (uuid)

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 (uuid)

Die eindeutige ID für die Datenquelle

GatewayDatasourceCredentialDetails

Objekt

Die Details der Datenquellenanmeldeinformationen

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

privacyLevel

Enumeration

Die Datenschutzstufe, die beim Kombinieren von Daten aus mehreren Quellen relevant ist.

Wert	Beschreibung
None
Public
Organizational
Private

PublishDatasourceToGatewayRequest

Objekt

Eine Veröffentlichungsdatenquelle für Gatewayanforderung

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

Freigeben über

Gateways - Create Datasource

Erlaubnisse

Erforderlicher Bereich

Einschränkungen

URI-Parameter

Anforderungstext

Antworten

Beispiele

Azure Analysis Services example

Beispielanforderung

Beispiel für eine Antwort

SQL example

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CredentialDetails

credentialType

encryptedConnection

encryptionAlgorithm

GatewayDatasource

GatewayDatasourceCredentialDetails

privacyLevel

PublishDatasourceToGatewayRequest