Gateways - Create Datasource

Référence

Service:: Power BI REST APIs

API Version:: v1.0

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

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

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

Notes

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

Autorisations

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

Étendue requise

Dataset.ReadWrite.All

Limites

Le réseau virtuel (VNet) et les passerelles cloud ne sont pas pris 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) dans le 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

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

Définitions

Nom	Description
CredentialDetails	Détails des informations d’identification
credentialType	Type d’informations d’identification de source de données
encryptedConnection	Indique s’il faut chiffrer la connexion à la source de données. L’appel d’API échoue si vous sélectionnez chiffrement et que Power BI ne parvient pas à é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 demande de publication de source de données sur la passerelle

CredentialDetails

Détails des informations d’identification

Nom	Type	Description
credentialType	credentialType	Type d’informations d’identification
credentials	string	Les informations d’identification, qui dépendent de la valeur « credentialType ». Pour plus d’informations, consultez Exemples de mise à jour de source de données .
encryptedConnection	encryptedConnection	Indique s’il faut chiffrer la connexion à la source de données. L’appel d’API échoue si vous sélectionnez chiffrement et que Power BI ne parvient pas à é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 du propriétaire). En règle générale, vous utilisez 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. Utilisez avec des sources de données qui prennent en charge l’authentification unique (SSO). En règle générale, vous utilisez cet indicateur ou `useCallerAADIdentity`.

credentialType

Type d’informations d’identification de source de données

Nom	Type	Description
Anonymous	string
Basic	string
Key	string
OAuth2	string
SAS	string
Windows	string

encryptedConnection

Indique s’il faut chiffrer la connexion à la source de données. L’appel d’API échoue si vous sélectionnez chiffrement et que Power BI ne parvient pas à établir une connexion chiffrée avec la source de données.

Nom	Type	Description
Encrypted	string
NotEncrypted	string

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.

Nom	Type	Description
None	string
RSA-OAEP	string

GatewayDatasource

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 pour la source de données qui doit être mise à jour. Les détails de connexion sont obligatoires lorsque le jeu de données a plusieurs sources de données.

credentialType

Type d’informations d’identification de source de données

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
Active Directory	AdobeAnalytics	AdoDotNet
AnalysisServices	AzureBlobs	AzureDataLakeStorage
AzureMarketplace	AzureTables	BizTalk
CDPA	CustomConnector	CustomHttpApi
DB2	Essbase	Event Hub
Excel	Exchange	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	Web

gatewayId

string

ID de passerelle associé. Lors de l’utilisation d’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

ID unique de la source de données

GatewayDatasourceCredentialDetails

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. Utilisez avec des sources de données qui prennent en charge l’authentification unique (SSO).

privacyLevel

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

Nom	Type	Description
None	string
Organizational	string
Private	string
Public	string

PublishDatasourceToGatewayRequest

Une demande de publication de source de données sur la 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

Gateways - Create Datasource

Autorisations

Étendue requise

Limites

Paramètres URI

Corps de la demande

Réponses

Exemples

Azure Analysis Services example

Sample Request

Sample Response

SQL example

Sample Request

Sample Response

Définitions

CredentialDetails

credentialType

encryptedConnection

encryptionAlgorithm

GatewayDatasource

GatewayDatasourceCredentialDetails

privacyLevel

PublishDatasourceToGatewayRequest

Ressources supplémentaires