Gateways - Create Datasource

Referência

Service:: Power BI REST APIs

API Version:: v1.0

Cria uma nova fonte de dados no gateway local especificado.

As credenciais da fonte de dados local devem ser criptografadas. O encryptedConnection parâmetro deve ser definido Encrypted como e as credenciais devem ser criptografadas usando a chave pública do gateway.

Consulte o script Criar PowerShell do DataSource do Gateway para obter um exemplo de como usar essa API. Esse script usa o script do PowerShell mencionado na observação abaixo para criptografar as credenciais.

Observação

Para criptografar credenciais, consulte Configurar credenciais programaticamente para o Power BI e examine os exemplos de EncryptCredentials .NET Core, Java, Python e PowerShell .

Permissões

Dá suporte apenas a gateways locais e o usuário deve ter permissões de administrador de gateway

Escopo necessário

Dataset.ReadWrite.All

Limitações

Não há suporte para gateways de rede virtual (VNet) e de nuvem.
Não há suporte para o OAuth2 como um tipo de credencial.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
gatewayId	path	True	string uuid	A ID do gateway. Ao usar um cluster de gateway, a ID do gateway refere-se ao gateway primário (primeiro) no cluster. Nesses casos, a ID do gateway é semelhante à ID do cluster de gateway.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
connectionDetails	True	string	Os detalhes da conexão
credentialDetails	True	CredentialDetails	Os detalhes da credencial
dataSourceName	True	string	O nome da fonte de dados
dataSourceType	True	string	O tipo de fonte de dados

Respostas

Nome	Tipo	Description
201 Created	GatewayDatasource	Criado

Exemplos

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

Definições

Nome	Description
CredentialDetails	Os detalhes da credencial
credentialType	O tipo de credencial da fonte de dados
encryptedConnection	Se a conexão da fonte de dados deve ser criptografada. A chamada à API falhará se você selecionar criptografia e o Power BI não conseguir estabelecer uma conexão criptografada com a fonte de dados.
encryptionAlgorithm	O algoritmo de criptografia. Para uma fonte de dados de nuvem, especifique `None`. Para uma fonte de dados local, especifique `RSA-OAEP` e use a chave pública do gateway para criptografar as credenciais.
GatewayDatasource	Uma fonte de dados do gateway do Power BI
GatewayDatasourceCredentialDetails	Os detalhes da credencial da fonte de dados
privacyLevel	O nível de privacidade, que é relevante ao combinar dados de várias fontes.
PublishDatasourceToGatewayRequest	Uma solicitação publicar fonte de dados no gateway

CredentialDetails

Os detalhes da credencial

Nome	Tipo	Description
credentialType	credentialType	O tipo de credencial
credentials	string	As credenciais, que dependem do valor 'credentialType'. Para obter mais informações, consulte Atualizar exemplos de fonte de dados .
encryptedConnection	encryptedConnection	Se a conexão da fonte de dados deve ser criptografada. A chamada à API falhará se você selecionar criptografia e o Power BI não conseguir estabelecer uma conexão criptografada com a fonte de dados.
encryptionAlgorithm	encryptionAlgorithm	O algoritmo de criptografia. Para uma fonte de dados de nuvem, especifique `None`. Para uma fonte de dados local, especifique `RSA-OAEP` e use a chave pública do gateway para criptografar as credenciais.
privacyLevel	privacyLevel	O nível de privacidade, que é relevante ao combinar dados de várias fontes.
useCallerAADIdentity	boolean	Se a identidade de Azure AD (credenciais do OAuth 2.0) do chamador de API (que deve ser o proprietário da fonte de dados) será usada para configurar as credenciais da fonte de dados (o token de acesso OAuth do proprietário). Normalmente, você usaria esse sinalizador ou `useEndUserOAuth2Credentials`.
useEndUserOAuth2Credentials	boolean	Se a identidade de Azure AD do usuário final (credenciais do OAuth 2.0) é usada ao se conectar à fonte de dados no modo DirectQuery. Use com fontes de dados que dão suporte ao SSO (logon único). Normalmente, você usaria esse sinalizador ou `useCallerAADIdentity`.

credentialType

O tipo de credencial da fonte de dados

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

encryptedConnection

Se a conexão da fonte de dados deve ser criptografada. A chamada à API falhará se você selecionar criptografia e o Power BI não conseguir estabelecer uma conexão criptografada com a fonte de dados.

Nome	Tipo	Description
Encrypted	string
NotEncrypted	string

encryptionAlgorithm

O algoritmo de criptografia. Para uma fonte de dados de nuvem, especifique None. Para uma fonte de dados local, especifique RSA-OAEP e use a chave pública do gateway para criptografar as credenciais.

Nome	Tipo	Description
None	string
RSA-OAEP	string

GatewayDatasource

Uma fonte de dados do gateway do Power BI

Nome

Tipo

Description

connectionDetails

string

Detalhes da conexão no formato JSON

credentialDetails

GatewayDatasourceCredentialDetails

Os detalhes da conexão para a fonte de dados que precisa de atualização. Os detalhes da conexão são obrigatórios quando o conjunto de dados tem mais de uma fonte de dados.

credentialType

O tipo de credencial da fonte de dados

datasourceName

string

O nome da fonte de dados

datasourceType

string

O tipo de fonte de dados.

Nome da API para a fonte de dados
ActiveDirectory	AdobeAnalytics	AdoDotNet
AnalysisServices	AzureBlobs	AzureDataLakeStorage
AzureMarketplace	AzureTables	BizTalk
CDPA	CustomConnector	CustomHttpApi
DB2	Essbase	EventHub
Excel	Exchange	Extensão
Facebook	Arquivo	Pasta
GoogleAnalytics	Hdfs	HDInsight
Informix	MQ	MySql
OData	ODBCODBC	OleDb
Oracle	PostgreSql	PowerQueryMashup
PubNub	Salesforce	SAPBW
SAPBWMessageServer	SapErp	SAPHana
SharePoint	SharePointDocLib	SharePointList
Sql	Sybase	Teradata
UIFlow	Web

gatewayId

string

A ID do gateway associado. Ao usar um cluster de gateway, a ID do gateway refere-se ao gateway primário (primeiro) no cluster e é semelhante à ID do cluster do gateway.

string

A ID exclusiva da fonte de dados

GatewayDatasourceCredentialDetails

Os detalhes da credencial da fonte de dados

Nome	Tipo	Description
useEndUserOAuth2Credentials	boolean	Se a identidade de Azure AD do usuário final (credenciais do OAuth 2.0) é usada ao se conectar à fonte de dados no modo DirectQuery. Use com fontes de dados que dão suporte ao SSO (logon único).

privacyLevel

O nível de privacidade, que é relevante ao combinar dados de várias fontes.

Nome	Tipo	Description
None	string
Organizational	string
Private	string
Public	string

PublishDatasourceToGatewayRequest

Uma solicitação publicar fonte de dados no gateway

Nome	Tipo	Description
connectionDetails	string	Os detalhes da conexão
credentialDetails	CredentialDetails	Os detalhes da credencial
dataSourceName	string	O nome da fonte de dados
dataSourceType	string	O tipo de fonte de dados

Gateways - Create Datasource

Permissões

Escopo necessário

Limitações

Parâmetros de URI

Corpo da solicitação

Respostas

Exemplos

Azure Analysis Services example

Sample Request

Sample Response

SQL example

Sample Request

Sample Response

Definições

CredentialDetails

credentialType

encryptedConnection

encryptionAlgorithm

GatewayDatasource

GatewayDatasourceCredentialDetails

privacyLevel

PublishDatasourceToGatewayRequest

Recursos adicionais