Gateways - Create Datasource

Usługa:: Power BI REST APIs

Wersja interfejsu API:: v1.0

Tworzy nowe źródło danych w określonej bramie lokalnej.

Poświadczenia lokalnego źródła danych muszą być szyfrowane. Parametr encryptedConnection musi być ustawiony na Encrypted , a poświadczenia powinny być szyfrowane przy użyciu klucza publicznego bramy.

Zobacz skrypt Create Gateway DataSource PowerShell (Tworzenie źródła danych bramy programu PowerShell), aby zapoznać się z przykładem użycia tego interfejsu API. Ten skrypt używa skryptu programu PowerShell wymienionego w poniższej notatce na potrzeby szyfrowania poświadczeń.

Uwaga / Notatka

Aby zaszyfrować poświadczenia, zobacz Konfigurowanie poświadczeń programowo dla usługi Power BI i zapoznaj się z przykładami programu EncryptCredentials .NET Core, Java, Python i PowerShell .

Permissions

Obsługuje tylko bramy lokalne, a użytkownik musi mieć uprawnienia administratora bramy

Wymagany zakres

Dataset.ReadWrite.All

Ograniczenia

Bramy sieci wirtualnej i chmury nie są obsługiwane.
Protokół OAuth2 jako typ poświadczeń nie jest obsługiwany.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
gatewayId	path	True	string (uuid)	Identyfikator bramy. W przypadku korzystania z klastra bramy identyfikator bramy odwołuje się do bramy podstawowej (pierwszej) w klastrze. W takich przypadkach identyfikator bramy jest podobny do identyfikatora klastra bramy.

Treść żądania

Nazwa	Wymagane	Typ	Opis
connectionDetails	True	string	Szczegóły połączenia
credentialDetails	True	CredentialDetails	Szczegóły poświadczeń
dataSourceName	True	string	Nazwa źródła danych
dataSourceType	True	string	Typ źródła danych

Odpowiedzi

Nazwa	Typ	Opis
201 Created	GatewayDatasource	Created

Przykłady

Azure Analysis Services example

SQL example

Azure Analysis Services example

Przykładowe żądanie

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

Treść żądania

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

Przykładowa odpowiedź

Kod stanu:: 200

SQL example

Przykładowe żądanie

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

Treść żądania

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

Przykładowa odpowiedź

Kod stanu:: 200

Definicje

Nazwa	Opis
CredentialDetails	Szczegóły poświadczeń
credentialType	Typ poświadczeń źródła danych
encryptedConnection	Czy chcesz zaszyfrować połączenie ze źródłem danych. Wywołanie interfejsu API zakończy się niepowodzeniem, jeśli wybierzesz szyfrowanie, a usługa Power BI nie może nawiązać zaszyfrowanego połączenia ze źródłem danych.
encryptionAlgorithm	Algorytm szyfrowania. W przypadku źródła danych w chmurze określ wartość `None`. W przypadku lokalnego źródła danych określ `RSA-OAEP` klucz publiczny bramy i użyj go do zaszyfrowania poświadczeń.
GatewayDatasource	Źródło danych bramy usługi Power BI
GatewayDatasourceCredentialDetails	Szczegóły poświadczeń źródła danych
privacyLevel	Poziom prywatności, który jest istotny podczas łączenia danych z wielu źródeł.
PublishDatasourceToGatewayRequest	Żądanie publikowania źródła danych do bramy

CredentialDetails

Objekt

Szczegóły poświadczeń

Nazwa	Typ	Opis
credentialType	credentialType	Typ poświadczeń
credentials	string	Poświadczenia, które zależą od wartości "credentialType". Aby uzyskać więcej informacji, zobacz Update Datasource examples (Aktualizowanie przykładów źródła danych).
encryptedConnection	encryptedConnection	Czy chcesz zaszyfrować połączenie ze źródłem danych. Wywołanie interfejsu API zakończy się niepowodzeniem, jeśli wybierzesz szyfrowanie, a usługa Power BI nie może nawiązać zaszyfrowanego połączenia ze źródłem danych.
encryptionAlgorithm	encryptionAlgorithm	Algorytm szyfrowania. W przypadku źródła danych w chmurze określ wartość `None`. W przypadku lokalnego źródła danych określ `RSA-OAEP` klucz publiczny bramy i użyj go do zaszyfrowania poświadczeń.
privacyLevel	privacyLevel	Poziom prywatności, który jest istotny podczas łączenia danych z wielu źródeł.
useCallerAADIdentity	boolean	Określa, czy tożsamość usługi Azure AD (poświadczenia OAuth 2.0) obiektu wywołującego interfejs API (który musi być właścicielem źródła danych) będzie używana do konfigurowania poświadczeń źródła danych (tokenu dostępu właściciela protokołu OAuth). Zazwyczaj należy użyć tej flagi lub `useEndUserOAuth2Credentials`.
useEndUserOAuth2Credentials	boolean	Określa, czy tożsamość usługi Azure AD użytkownika końcowego (poświadczenia OAuth 2.0) jest używana podczas nawiązywania połączenia ze źródłem danych w trybie DirectQuery. Używaj z źródłami danych, które obsługują logowanie jednokrotne. Zazwyczaj należy użyć tej flagi lub `useCallerAADIdentity`.

credentialType

Wyliczanie

Typ poświadczeń źródła danych

Wartość	Opis
Basic
Windows
Anonymous
OAuth2
Key
SAS

encryptedConnection

Wyliczanie

Czy chcesz zaszyfrować połączenie ze źródłem danych. Wywołanie interfejsu API zakończy się niepowodzeniem, jeśli wybierzesz szyfrowanie, a usługa Power BI nie może nawiązać zaszyfrowanego połączenia ze źródłem danych.

Wartość	Opis
Encrypted
NotEncrypted

encryptionAlgorithm

Wyliczanie

Algorytm szyfrowania. W przypadku źródła danych w chmurze określ wartość None. W przypadku lokalnego źródła danych określ RSA-OAEP klucz publiczny bramy i użyj go do zaszyfrowania poświadczeń.

Wartość	Opis
None
RSA-OAEP

GatewayDatasource

Objekt

Źródło danych bramy usługi Power BI

Nazwa

Typ

Opis

connectionDetails

string

Szczegóły połączenia w formacie JSON

credentialDetails

GatewayDatasourceCredentialDetails

Szczegóły połączenia dla źródła danych, które wymaga aktualizacji. Szczegóły połączenia są obowiązkowe, gdy zestaw danych ma więcej niż jedno źródło danych.

credentialType

Typ poświadczeń źródła danych

datasourceName

string

Nazwa źródła danych

datasourceType

string

Typ źródła danych.

Nazwa interfejsu API dla źródła danych
ActiveDirectory	AdobeAnalytics	AdoDotNet
AnalysisServices	AzureBlobs	AzureDataLakeStorage
AzureMarketplace	AzureTables	BizTalk
CDPA	CustomConnector	CustomHttpApi
DB2	Essbase	EventHub
Excel	Wymiana	Extension
Facebook	File	Folder
GoogleAnalytics	Hdfs	HDInsight
Informix	MQ	MySql
OData	ODBC	OleDb
Oracle	PostgreSql	PowerQueryMashup
PubNub	Salesforce	SAPBW
SAPBWMessageServer	SapErp	SAPHana
SharePoint	SharePointDocLib	Lista programu SharePoint
SQL	Sybase	Teradata
UIFlow	sieć Web

gatewayId

string (uuid)

Skojarzony identyfikator bramy. W przypadku korzystania z klastra bramy identyfikator bramy odnosi się do bramy podstawowej (pierwszej) w klastrze i jest podobny do identyfikatora klastra bramy.

string (uuid)

Unikatowy identyfikator źródła danych

GatewayDatasourceCredentialDetails

Objekt

Szczegóły poświadczeń źródła danych

Nazwa	Typ	Opis
useEndUserOAuth2Credentials	boolean	Określa, czy tożsamość usługi Azure AD użytkownika końcowego (poświadczenia OAuth 2.0) jest używana podczas nawiązywania połączenia ze źródłem danych w trybie DirectQuery. Używaj z źródłami danych, które obsługują logowanie jednokrotne.

privacyLevel

Wyliczanie

Poziom prywatności, który jest istotny podczas łączenia danych z wielu źródeł.

Wartość	Opis
None
Public
Organizational
Private

PublishDatasourceToGatewayRequest

Objekt

Żądanie publikowania źródła danych do bramy

Nazwa	Typ	Opis
connectionDetails	string	Szczegóły połączenia
credentialDetails	CredentialDetails	Szczegóły poświadczeń
dataSourceName	string	Nazwa źródła danych
dataSourceType	string	Typ źródła danych

Udostępnij przez

Gateways - Create Datasource

Permissions

Wymagany zakres

Ograniczenia

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Przykłady

Azure Analysis Services example

Przykładowe żądanie

Przykładowa odpowiedź

SQL example

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

CredentialDetails

credentialType

encryptedConnection

encryptionAlgorithm

GatewayDatasource

GatewayDatasourceCredentialDetails

privacyLevel

PublishDatasourceToGatewayRequest