Gateways - Create Datasource

Riferimento

Servizio:: Power BI REST APIs

Versione API:: v1.0

Crea una nuova origine dati nel gateway locale specificato.

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

Per un esempio di uso di questa API, vedere l'Create Gateway DataSource script di PowerShell. 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 .NET Core, Java, Python e powerShell esempi.

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	Creato

Esempio

Azure Analysis Services example

SQL example

Azure Analysis Services example

Esempio di richiesta

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

Corpo della richiesta

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

Risposta di esempio

Codice di stato:: 200

SQL example

Esempio di richiesta

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

Corpo della richiesta

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

Risposta di esempio

Codice di stato:: 200

Definizioni

Nome	Descrizione
CredentialDetails	Dettagli delle credenziali
credentialType	Tipo di origine dati credenziali
encryptedConnection	Indica 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 `RSA-OAEP` e usare la chiave pubblica del gateway per crittografare le credenziali.
GatewayDatasource	Un'origine dati di Power BI Gateway
GatewayDatasourceCredentialDetails	Dettagli delle credenziali dell'origine dati
privacyLevel	Il livello di privacy, che è rilevante quando si combinano dati da più origini.
PublishDatasourceToGatewayRequest	Un'origine dati di pubblicazione nella richiesta del gateway

CredentialDetails

Object

Dettagli delle credenziali

Nome	Tipo	Descrizione
credentialType	credentialType	Tipo di credenziale
credentials	string	Credenziali, che dipendono dal valore 'credentialType'. Per altre informazioni, vedere esempi di di aggiornamento dell'origine dati.
encryptedConnection	encryptedConnection	Indica 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 `RSA-OAEP` e usare la chiave pubblica del gateway per crittografare le credenziali.
privacyLevel	privacyLevel	Il livello di privacy, che è rilevante quando si combinano 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 (token di accesso OAuth proprietario). In genere, è possibile usare questo flag o `useEndUserOAuth2Credentials`.
useEndUserOAuth2Credentials	boolean	Indica se l'identità di Azure AD dell'utente finale (credenziali OAuth 2.0) viene usata durante la connessione all'origine dati in modalità DirectQuery. Usare con le origini dati che supportano Single Sign-On (SSO). In genere, è possibile usare questo flag o `useCallerAADIdentity`.

credentialType

Enumerazione

Tipo di origine dati credenziali

Valore	Descrizione
Anonymous
Basic
Key
OAuth2
SAS
Windows

encryptedConnection

Enumerazione

Indica 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.

Valore	Descrizione
Encrypted
NotEncrypted

encryptionAlgorithm

Enumerazione

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

Valore	Descrizione
None
RSA-OAEP

GatewayDatasource

Object

Un'origine dati di Power BI Gateway

Nome

Tipo

Descrizione

connectionDetails

string

Dettagli della connessione in formato JSON

credentialDetails

GatewayDatasourceCredentialDetails

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

credentialType

Tipo di origine dati credenziali

datasourceName

string

Nome dell'origine dati

datasourceType

string

Tipo di origine dati .

Nome API per l'origine dati
ActiveDirectory	AdobeAnalytics	AdoDotNet
AnalysisServices	AzureBlobs	AzureDataLakeStorage
AzureMarketplace	AzureTables	BizTalk
CDPA	CustomConnector	CustomHttpApi
DB2	Essbase	EventHub
Excel	Scambio	Estensione
Facebook	Documento	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 (uuid)

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

string (uuid)

ID univoco per l'origine dati

GatewayDatasourceCredentialDetails

Object

Dettagli delle credenziali dell'origine dati

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

privacyLevel

Enumerazione

Il livello di privacy, che è rilevante quando si combinano dati da più origini.

Valore	Descrizione
None
Organizational
Private
Public

PublishDatasourceToGatewayRequest

Object

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

Esempio di richiesta

Risposta di esempio

SQL example

Esempio di richiesta

Risposta di esempio

Definizioni

CredentialDetails

credentialType

encryptedConnection

encryptionAlgorithm

GatewayDatasource

GatewayDatasourceCredentialDetails

privacyLevel

PublishDatasourceToGatewayRequest