Gateways - Create Datasource

Service:: Power BI REST APIs

Version d'API:: v1.0

Crée une source de données sur la passerelle locale spécifiée.

Les informations d’identification de source de données locales doivent être chiffrées. Le paramètre encryptedConnection doit être défini sur Encrypted et les informations d’identification doivent être chiffrées à l’aide de la clé publique de passerelle.

Consultez la Créer une source de données de passerelle script PowerShell pour obtenir un exemple d’utilisation de cette API, ce script utilise le script PowerShell mentionné dans la remarque ci-dessous pour chiffrer les informations d’identification.

Remarque

Pour chiffrer les informations d’identification, consultez Configurer les informations d’identification par programmation pour Power BI et passez en revue les exemples .NET Core, Java, Python et PowerShell exemples.

Autorisations

Prend uniquement en charge les passerelles locales et l’utilisateur doit disposer d’autorisations d’administrateur de passerelle

Étendue requise

Dataset.ReadWrite.All

Limites

Les passerelles de réseau virtuel et de cloud ne sont pas prises en charge.
OAuth2 en tant que type d’informations d’identification n’est pas pris en charge.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
gatewayId	path	True	string (uuid)	ID de passerelle. Lors de l’utilisation d’un cluster de passerelle, l’ID de passerelle fait référence à la passerelle principale (première) du cluster. Dans ce cas, l’ID de passerelle est similaire à l’ID de cluster de passerelle.

Corps de la demande

Nom	Obligatoire	Type	Description
connectionDetails	True	string	Détails de la connexion
credentialDetails	True	CredentialDetails	Détails des informations d’identification
dataSourceName	True	string	Nom de la source de données
dataSourceType	True	string	Type de source de données

Réponses

Nom	Type	Description
201 Created	GatewayDatasource	Date de création

Exemples

Azure Analysis Services example

SQL example

Azure Analysis Services example

Exemple de requête

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

Corps de la demande

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

Exemple de réponse

Code d’état:: 200

SQL example

Exemple de requête

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

Corps de la demande

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

Exemple de réponse

Code d’état:: 200

Définitions

Nom	Description
CredentialDetails	Détails des informations d’identification
credentialType	Type de source de données informations d’identification
encryptedConnection	Indique s’il faut chiffrer la connexion de source de données. L’appel d’API échoue si vous sélectionnez le chiffrement et Que Power BI n’est pas en mesure d’établir une connexion chiffrée avec la source de données.
encryptionAlgorithm	Algorithme de chiffrement. Pour une source de données cloud, spécifiez `None`. Pour une source de données locale, spécifiez `RSA-OAEP` et utilisez la clé publique de passerelle pour chiffrer les informations d’identification.
GatewayDatasource	Une source de données de passerelle Power BI
GatewayDatasourceCredentialDetails	Détails des informations d’identification de la source de données
privacyLevel	Niveau de confidentialité, qui est pertinent lors de la combinaison de données provenant de plusieurs sources.
PublishDatasourceToGatewayRequest	Une source de données de publication sur la demande de passerelle

CredentialDetails

Object

Détails des informations d’identification

Nom	Type	Description
credentialType	credentialType	Type d’informations d’identification
credentials	string	Informations d’identification, qui dépendent de la valeur « credentialType ». Pour plus d’informations, consultez Mettre à jour des exemples de source de données.
encryptedConnection	encryptedConnection	Indique s’il faut chiffrer la connexion de source de données. L’appel d’API échoue si vous sélectionnez le chiffrement et Que Power BI n’est pas en mesure d’établir une connexion chiffrée avec la source de données.
encryptionAlgorithm	encryptionAlgorithm	Algorithme de chiffrement. Pour une source de données cloud, spécifiez `None`. Pour une source de données locale, spécifiez `RSA-OAEP` et utilisez la clé publique de passerelle pour chiffrer les informations d’identification.
privacyLevel	privacyLevel	Niveau de confidentialité, qui est pertinent lors de la combinaison de données provenant de plusieurs sources.
useCallerAADIdentity	boolean	Indique si l’identité Azure AD (informations d’identification OAuth 2.0) de l’appelant d’API (qui doit être le propriétaire de la source de données) sera utilisée pour configurer les informations d’identification de la source de données (le jeton d’accès OAuth propriétaire). En règle générale, vous utiliseriez cet indicateur ou `useEndUserOAuth2Credentials`.
useEndUserOAuth2Credentials	boolean	Indique si l’identité Azure AD de l’utilisateur final (informations d’identification OAuth 2.0) est utilisée lors de la connexion à la source de données en mode DirectQuery. Utiliser avec des sources de données qui prennent en charge 'authentification unique (SSO). En règle générale, vous utiliseriez cet indicateur ou `useCallerAADIdentity`.

credentialType

Énumération

Type de source de données informations d’identification

Valeur	Description
Basic
Windows
Anonymous
OAuth2
Key
SAS

encryptedConnection

Énumération

Indique s’il faut chiffrer la connexion de source de données. L’appel d’API échoue si vous sélectionnez le chiffrement et Que Power BI n’est pas en mesure d’établir une connexion chiffrée avec la source de données.

Valeur	Description
Encrypted
NotEncrypted

encryptionAlgorithm

Énumération

Algorithme de chiffrement. Pour une source de données cloud, spécifiez None. Pour une source de données locale, spécifiez RSA-OAEP et utilisez la clé publique de passerelle pour chiffrer les informations d’identification.

Valeur	Description
None
RSA-OAEP

GatewayDatasource

Object

Une source de données de passerelle Power BI

Nom

Type

Description

connectionDetails

string

Détails de connexion au format JSON

credentialDetails

GatewayDatasourceCredentialDetails

Détails de connexion de la source de données qui a besoin de la mise à jour. Les détails de connexion sont obligatoires lorsque le jeu de données possède plusieurs sources de données.

credentialType

Type de source de données informations d’identification

datasourceName

string

Nom de la source de données

datasourceType

string

Type de source de données .

Nom de l’API pour la source de données
ActiveDirectory	AdobeAnalytics	AdoDotNet
AnalysisServices	AzureBlobs	AzureDataLakeStorage
AzureMarketplace	AzureTables	BizTalk
CDPA	CustomConnector	CustomHttpApi
DB2	Essbase	EventHub
Excel	Échange	Extension
Facebook	Fichier	Dossier
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	le Web

gatewayId

string (uuid)

ID de passerelle associé. Lorsque vous utilisez un cluster de passerelle, l’ID de passerelle fait référence à la passerelle principale (première) du cluster et est similaire à l’ID de cluster de passerelle.

string (uuid)

ID unique de la source de données

GatewayDatasourceCredentialDetails

Object

Détails des informations d’identification de la source de données

Nom	Type	Description
useEndUserOAuth2Credentials	boolean	Indique si l’identité Azure AD de l’utilisateur final (informations d’identification OAuth 2.0) est utilisée lors de la connexion à la source de données en mode DirectQuery. Utiliser avec des sources de données qui prennent en charge 'authentification unique (SSO).

privacyLevel

Énumération

Niveau de confidentialité, qui est pertinent lors de la combinaison de données provenant de plusieurs sources.

Valeur	Description
None
Public
Organizational
Private

PublishDatasourceToGatewayRequest

Object

Une source de données de publication sur la demande de passerelle

Nom	Type	Description
connectionDetails	string	Détails de la connexion
credentialDetails	CredentialDetails	Détails des informations d’identification
dataSourceName	string	Nom de la source de données
dataSourceType	string	Type de source de données

Partager via

Gateways - Create Datasource

Autorisations

Étendue requise

Limites

Paramètres URI

Corps de la demande

Réponses

Exemples

Azure Analysis Services example

Exemple de requête

Exemple de réponse

SQL example

Exemple de requête

Exemple de réponse

Définitions

CredentialDetails

credentialType

encryptedConnection

encryptionAlgorithm

GatewayDatasource

GatewayDatasourceCredentialDetails

privacyLevel

PublishDatasourceToGatewayRequest