Gateways - Create Datasource

Riferimento

Service:: Power BI REST APIs

API Version:: v1.0

Crea una nuova origine dati nel gateway locale specificato.

Le credenziali dell'origine dati locale devono essere crittografate. Il encryptedConnection parametro deve essere impostato su Encrypted e le credenziali devono essere crittografate usando la chiave pubblica del gateway.

Per crittografare le credenziali, vedere lo script Create Gateway DataSource PowerShell per un esempio di uso di questa API. Questo script usa lo script di PowerShell indicato nella nota seguente per crittografare le credenziali.

Nota

Per crittografare le credenziali, vedere Configurare le credenziali a livello di codice per Power BI ed esaminare gli esempi di EncryptCredentials .NET Core, Java, Python e PowerShell .

Autorizzazioni

Supporta solo i gateway locali e l'utente deve disporre delle autorizzazioni di amministratore del gateway

Ambito obbligatorio

Dataset.ReadWrite.All

Limitazioni

Le reti virtuali e i gateway cloud non sono supportati.
OAuth2 come tipo di credenziale non è supportato.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
gatewayId	path	True	string uuid	ID gateway. Quando si usa un cluster gateway, l'ID gateway fa riferimento al gateway primario (primo) nel cluster. In questi casi, l'ID gateway è simile all'ID cluster del gateway.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
connectionDetails	True	string	Dettagli della connessione
credentialDetails	True	CredentialDetails	Dettagli delle credenziali
dataSourceName	True	string	Nome origine dati
dataSourceType	True	string	Tipo di origine dati

Risposte

Nome	Tipo	Descrizione
201 Created	GatewayDatasource	Data di creazione

Esempio

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

Definizioni

Nome	Descrizione
CredentialDetails	Dettagli delle credenziali
credentialType	Tipo di credenziali dell'origine dati
encryptedConnection	Se crittografare la connessione all'origine dati. La chiamata API avrà esito negativo se si seleziona la crittografia e Power BI non è in grado di stabilire una connessione crittografata con l'origine dati.
encryptionAlgorithm	Algoritmo di crittografia. Per un'origine dati cloud, specificare `None`. Per un'origine dati locale, specificare e usare la chiave pubblica del gateway per crittografare `RSA-OAEP` le credenziali.
GatewayDatasource	Origine dati del gateway Power BI
GatewayDatasourceCredentialDetails	Dettagli delle credenziali dell'origine dati
privacyLevel	Livello di privacy, rilevante quando si combinano i dati da più origini.
PublishDatasourceToGatewayRequest	Un'origine dati di pubblicazione nella richiesta del gateway

CredentialDetails

Dettagli delle credenziali

Nome	Tipo	Descrizione
credentialType	credentialType	Tipo di credenziali
credentials	string	Le credenziali, che dipendono dal valore "credentialType". Per altre informazioni, vedere Aggiornare esempi di origine dati .
encryptedConnection	encryptedConnection	Se crittografare la connessione all'origine dati. La chiamata API avrà esito negativo se si seleziona la crittografia e Power BI non è in grado di stabilire una connessione crittografata con l'origine dati.
encryptionAlgorithm	encryptionAlgorithm	Algoritmo di crittografia. Per un'origine dati cloud, specificare `None`. Per un'origine dati locale, specificare e usare la chiave pubblica del gateway per crittografare `RSA-OAEP` le credenziali.
privacyLevel	privacyLevel	Livello di privacy, rilevante quando si combinano i dati da più origini.
useCallerAADIdentity	boolean	Se l'identità di Azure AD (credenziali OAuth 2.0) del chiamante API (che deve essere il proprietario dell'origine dati) verrà usata per configurare le credenziali dell'origine dati (il token di accesso OAuth proprietario). In genere, si userebbe questo flag o `useEndUserOAuth2Credentials`.
useEndUserOAuth2Credentials	boolean	Se l'identità dell'utente finale di Azure AD (credenziali OAuth 2.0) viene usata durante la connessione all'origine dati in modalità DirectQuery. Usare con origini dati che supportano l'accesso Single Sign-On (SSO). In genere, si userebbe questo flag o `useCallerAADIdentity`.

credentialType

Tipo di credenziali dell'origine dati

Nome	Tipo	Descrizione
Anonymous	string
Basic	string
Key	string
OAuth2	string
SAS	string
Windows	string

encryptedConnection

Se crittografare la connessione all'origine dati. La chiamata API avrà esito negativo se si seleziona la crittografia e Power BI non è in grado di stabilire una connessione crittografata con l'origine dati.

Nome	Tipo	Descrizione
Encrypted	string
NotEncrypted	string

encryptionAlgorithm

Algoritmo di crittografia. Per un'origine dati cloud, specificare None. Per un'origine dati locale, specificare e usare la chiave pubblica del gateway per crittografare RSA-OAEP le credenziali.

Nome	Tipo	Descrizione
None	string
RSA-OAEP	string

GatewayDatasource

Origine dati del gateway Power BI

Nome

Tipo

Descrizione

connectionDetails

string

Dettagli connessione in formato JSON

credentialDetails

GatewayDatasourceCredentialDetails

Dettagli della connessione per l'origine dati necessaria per l'aggiornamento. I dettagli della connessione sono obbligatori quando il set di dati ha più di un'origine dati.

credentialType

Tipo di credenziali dell'origine dati

datasourceName

string

Nome dell'origine dei dati.

datasourceType

string

Tipo di origine dati.

Nome API per l'origine dati
ActiveDirectory	AdobeAnalytics	AdoDotNet
AnalysisServices	AzureBlobs	AzureDataLakeStorage
AzureMarketplace	Tabelle di Azure	BizTalk
CDPA	CustomConnector	CustomHttpApi
DB2	Essbase	Hub eventi
Excel	Exchange	Estensione
Facebook	File	Cartella
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

ID gateway associato. Quando si usa un cluster gateway, l'ID gateway fa riferimento al gateway primario (primo) nel cluster ed è simile all'ID del cluster gateway.

string

ID univoco per l'origine dati

GatewayDatasourceCredentialDetails

Dettagli delle credenziali dell'origine dati

Nome	Tipo	Descrizione
useEndUserOAuth2Credentials	boolean	Se l'identità dell'utente finale di Azure AD (credenziali OAuth 2.0) viene usata durante la connessione all'origine dati in modalità DirectQuery. Usare con origini dati che supportano l'accesso Single Sign-On (SSO).

privacyLevel

Livello di privacy, rilevante quando si combinano i dati da più origini.

Nome	Tipo	Descrizione
None	string
Organizational	string
Private	string
Public	string

PublishDatasourceToGatewayRequest

Un'origine dati di pubblicazione nella richiesta del gateway

Nome	Tipo	Descrizione
connectionDetails	string	Dettagli della connessione
credentialDetails	CredentialDetails	Dettagli delle credenziali
dataSourceName	string	Nome origine dati
dataSourceType	string	Tipo di origine dati

Condividi tramite

Gateways - Create Datasource

Autorizzazioni

Ambito obbligatorio

Limitazioni

Parametri dell'URI

Corpo della richiesta

Risposte

Esempio

Azure Analysis Services example

Sample Request

Sample Response

SQL example

Sample Request

Sample Response

Definizioni

CredentialDetails

credentialType

encryptedConnection

encryptionAlgorithm

GatewayDatasource

GatewayDatasourceCredentialDetails

privacyLevel

PublishDatasourceToGatewayRequest

Risorse aggiuntive