Gateways - Create Datasource

Referencia

Service:: Power BI REST APIs

API Version:: v1.0

Crea un nuevo origen de datos en la puerta de enlace local especificada.

Las credenciales del origen de datos local deben cifrarse. El encryptedConnection parámetro debe establecerse en Encrypted y las credenciales se deben cifrar mediante la clave pública de puerta de enlace.

Consulte el script de PowerShell Create Gateway DataSource para obtener un ejemplo de uso de esta API. Este script usa el script de PowerShell mencionado en la nota siguiente para cifrar las credenciales.

Nota

Para cifrar las credenciales, consulte Configuración de credenciales mediante programación para Power BI y revise los ejemplos de EncryptCredentials .NET Core, Java, Python y PowerShell .

Permisos

Solo admite puertas de enlace locales y el usuario debe tener permisos de administrador de puerta de enlace.

Ámbito requerido

Dataset.ReadWrite.All

Limitaciones

No se admiten redes virtuales (VNet) ni puertas de enlace en la nube.
No se admite OAuth2 como tipo de credencial.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
gatewayId	path	True	string uuid	Identificador de puerta de enlace. Cuando se usa un clúster de puerta de enlace, el identificador de puerta de enlace hace referencia a la puerta de enlace principal (primera) del clúster. En tales casos, el identificador de puerta de enlace es similar al identificador del clúster de puerta de enlace.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
connectionDetails	True	string	Detalles de conexión
credentialDetails	True	CredentialDetails	Detalles de las credenciales
dataSourceName	True	string	Nombre del origen de datos
dataSourceType	True	string	Tipo de origen de datos

Respuestas

Nombre	Tipo	Description
201 Created	GatewayDatasource	Creado

Ejemplos

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

Definiciones

Nombre	Description
CredentialDetails	Detalles de las credenciales
credentialType	Tipo de credencial del origen de datos
encryptedConnection	Si se va a cifrar la conexión del origen de datos. Se producirá un error en la llamada API si selecciona cifrado y Power BI no puede establecer una conexión cifrada con el origen de datos.
encryptionAlgorithm	Algoritmo de cifrado. Para un origen de datos en la nube, especifique `None`. Para un origen de datos local, especifique `RSA-OAEP` y use la clave pública de puerta de enlace para cifrar las credenciales.
GatewayDatasource	Un origen de datos de puerta de enlace de Power BI
GatewayDatasourceCredentialDetails	Detalles de las credenciales del origen de datos
privacyLevel	Nivel de privacidad, que es relevante al combinar datos de varios orígenes.
PublishDatasourceToGatewayRequest	Un origen de datos de publicación en una solicitud de puerta de enlace

CredentialDetails

Detalles de las credenciales

Nombre	Tipo	Description
credentialType	credentialType	Tipo de credencial
credentials	string	Las credenciales, que dependen del valor "credentialType". Para obtener más información, vea Actualizar ejemplos de orígenes de datos .
encryptedConnection	encryptedConnection	Si se va a cifrar la conexión del origen de datos. Se producirá un error en la llamada API si selecciona cifrado y Power BI no puede establecer una conexión cifrada con el origen de datos.
encryptionAlgorithm	encryptionAlgorithm	Algoritmo de cifrado. Para un origen de datos en la nube, especifique `None`. Para un origen de datos local, especifique `RSA-OAEP` y use la clave pública de puerta de enlace para cifrar las credenciales.
privacyLevel	privacyLevel	Nivel de privacidad, que es relevante al combinar datos de varios orígenes.
useCallerAADIdentity	boolean	Si la identidad de Azure AD (credenciales de OAuth 2.0) del autor de la llamada de API (que debe ser el propietario del origen de datos) se usará para configurar las credenciales del origen de datos (el token de acceso de OAuth propietario). Normalmente, usaría esta marca o `useEndUserOAuth2Credentials`.
useEndUserOAuth2Credentials	boolean	Si se usa la identidad de Azure AD del usuario final (credenciales de OAuth 2.0) al conectarse al origen de datos en modo DirectQuery. Use con orígenes de datos que admitan el inicio de sesión único (SSO) . Normalmente, usaría esta marca o `useCallerAADIdentity`.

credentialType

Tipo de credencial del origen de datos

Nombre	Tipo	Description
Anonymous	string
Basic	string
Key	string
OAuth2	string
SAS	string
Windows	string

encryptedConnection

Si se va a cifrar la conexión del origen de datos. Se producirá un error en la llamada API si selecciona cifrado y Power BI no puede establecer una conexión cifrada con el origen de datos.

Nombre	Tipo	Description
Encrypted	string
NotEncrypted	string

encryptionAlgorithm

Algoritmo de cifrado. Para un origen de datos en la nube, especifique None. Para un origen de datos local, especifique RSA-OAEP y use la clave pública de puerta de enlace para cifrar las credenciales.

Nombre	Tipo	Description
None	string
RSA-OAEP	string

GatewayDatasource

Un origen de datos de puerta de enlace de Power BI

Nombre

Tipo

Description

connectionDetails

string

Detalles de conexión en formato JSON

credentialDetails

GatewayDatasourceCredentialDetails

Detalles de conexión del origen de datos que necesita actualizarse. Los detalles de conexión son obligatorios cuando el conjunto de datos tiene más de un origen de datos.

credentialType

Tipo de credencial del origen de datos

datasourceName

string

Nombre del origen de datos

datasourceType

string

Tipo de origen de datos.

Nombre de la API para el origen de datos
ActiveDirectory	AdobeAnalytics	AdoDotNet
AnalysisServices	AzureBlobs	AzureDataLakeStorage
AzureMarketplace	AzureTables	BizTalk
CDPA	CustomConnector	CustomHttpApi
DB2	Essbase	EventHub
Excel	Exchange	Comprobación de actualización
Facebook	Archivo	Carpeta
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

Identificador de puerta de enlace asociado. Cuando se usa un clúster de puerta de enlace, el identificador de puerta de enlace hace referencia a la puerta de enlace principal (primera) del clúster y es similar al identificador del clúster de puerta de enlace.

string

Identificador único del origen de datos

GatewayDatasourceCredentialDetails

Detalles de las credenciales del origen de datos

Nombre	Tipo	Description
useEndUserOAuth2Credentials	boolean	Si se usa la identidad de Azure AD del usuario final (credenciales de OAuth 2.0) al conectarse al origen de datos en modo DirectQuery. Use con orígenes de datos que admitan el inicio de sesión único (SSO) .

privacyLevel

Nivel de privacidad, que es relevante al combinar datos de varios orígenes.

Nombre	Tipo	Description
None	string
Organizational	string
Private	string
Public	string

PublishDatasourceToGatewayRequest

Un origen de datos de publicación en una solicitud de puerta de enlace

Nombre	Tipo	Description
connectionDetails	string	Detalles de conexión
credentialDetails	CredentialDetails	Detalles de las credenciales
dataSourceName	string	Nombre del origen de datos
dataSourceType	string	Tipo de origen de datos

Compartir a través de

Gateways - Create Datasource

Permisos

Ámbito requerido

Limitaciones

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Ejemplos

Azure Analysis Services example

Sample Request

Sample Response

SQL example

Sample Request

Sample Response

Definiciones

CredentialDetails

credentialType

encryptedConnection

encryptionAlgorithm

GatewayDatasource

GatewayDatasourceCredentialDetails

privacyLevel

PublishDatasourceToGatewayRequest

Recursos adicionales