Gateways - Create Datasource

参考

服务:: Power BI REST APIs

API 版本:: v1.0

在指定的本地网关上创建新的数据源。

必须加密本地数据源凭据。 encryptedConnection 参数必须设置为 Encrypted，并且应使用网关公钥加密凭据。

有关使用此 API 的示例，请参阅创建网关 DataSource PowerShell 脚本，此脚本使用以下说明中提到的 PowerShell 脚本来加密凭据。

注释

若要加密凭据，请参阅以编程方式为 Power BI 配置凭据，并查看 EncryptCredentials .NET Core、Java、Python 和 PowerShell 示例。

权限

仅支持本地网关，用户必须具有网关管理员权限

所需范围

Dataset.ReadWrite.All

局限性

不支持虚拟网络（VNet）和云网关。
不支持 OAuth2 作为凭据类型。

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

URI 参数

名称	在	必需	类型	说明
gatewayId	path	True	string (uuid)	网关 ID。使用网关群集时，网关 ID 是指群集中的主网关（第一个）网关。在这种情况下，网关 ID 类似于网关群集 ID。

请求正文

名称	必需	类型	说明
connectionDetails	True	string	连接详细信息
credentialDetails	True	CredentialDetails	凭据详细信息
dataSourceName	True	string	数据源名称
dataSourceType	True	string	数据源类型

响应

名称	类型	说明
201 Created	GatewayDatasource	已创建

示例

Azure Analysis Services example

SQL example

Azure Analysis Services example

示例请求

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

请求正文

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

示例响应

状态代码:: 200

SQL example

示例请求

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

请求正文

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

示例响应

状态代码:: 200

定义

名称	说明
CredentialDetails	凭据详细信息
credentialType	数据源类型凭据
encryptedConnection	是否加密数据源连接。如果选择加密，并且 Power BI 无法与数据源建立加密连接，则 API 调用将失败。
encryptionAlgorithm	加密算法。对于云数据源，请指定 `None`。对于本地数据源，请指定 `RSA-OAEP` 并使用网关公钥加密凭据。
GatewayDatasource	Power BI 网关数据源
GatewayDatasourceCredentialDetails	数据源凭据详细信息
privacyLevel	隐私级别，在合并来自多个源的数据时相关。
PublishDatasourceToGatewayRequest	将数据源发布到网关请求

CredentialDetails

Object

凭据详细信息

名称	类型	说明
credentialType	credentialType	凭据类型
credentials	string	凭据，具体取决于“credentialType”值。有关详细信息，请参阅更新数据源示例。
encryptedConnection	encryptedConnection	是否加密数据源连接。如果选择加密，并且 Power BI 无法与数据源建立加密连接，则 API 调用将失败。
encryptionAlgorithm	encryptionAlgorithm	加密算法。对于云数据源，请指定 `None`。对于本地数据源，请指定 `RSA-OAEP` 并使用网关公钥加密凭据。
privacyLevel	privacyLevel	隐私级别，在合并来自多个源的数据时相关。
useCallerAADIdentity	boolean	API 调用方（必须是数据源所有者）的 Azure AD 标识（OAuth 2.0 凭据）是否用于配置数据源凭据（所有者 OAuth 访问令牌）。通常，可以使用此标志或 `useEndUserOAuth2Credentials`。
useEndUserOAuth2Credentials	boolean	在 DirectQuery 模式下连接到数据源时，是否使用最终用户 Azure AD 标识（OAuth 2.0 凭据）。与支持单一登录（SSO）的数据源配合使用。通常，可以使用此标志或 `useCallerAADIdentity`。

credentialType

枚举

数据源类型凭据

值	说明
Anonymous
Basic
Key
OAuth2
SAS
Windows

encryptedConnection

枚举

是否加密数据源连接。如果选择加密，并且 Power BI 无法与数据源建立加密连接，则 API 调用将失败。

值	说明
Encrypted
NotEncrypted

encryptionAlgorithm

枚举

加密算法。对于云数据源，请指定 None。对于本地数据源，请指定 RSA-OAEP 并使用网关公钥加密凭据。

值	说明
None
RSA-OAEP

GatewayDatasource

Object

Power BI 网关数据源

名称

类型

说明

connectionDetails

string

JSON 格式的连接详细信息

credentialDetails

GatewayDatasourceCredentialDetails

需要更新的数据源的连接详细信息。当数据集具有多个数据源时，连接详细信息是必需的。

credentialType

数据源类型凭据

datasourceName

string

数据源的名称

datasourceType

string

数据源的类型。

数据源的 API 名称
ActiveDirectory	AdobeAnalytics	AdoDotNet
AnalysisServices	AzureBlobs	AzureDataLakeStorage
AzureMarketplace	AzureTables	BizTalk
CDPA	CustomConnector	CustomHttpApi
DB2	Essbase	EventHub
Excel	交流	扩展
Facebook	文件	文件夹
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	网络

gatewayId

string (uuid)

关联的网关 ID。使用网关群集时，网关 ID 引用群集中的主网关（第一个）网关，类似于网关群集 ID。

string (uuid)

数据源的唯一 ID

GatewayDatasourceCredentialDetails

Object

数据源凭据详细信息

名称	类型	说明
useEndUserOAuth2Credentials	boolean	在 DirectQuery 模式下连接到数据源时，是否使用最终用户 Azure AD 标识（OAuth 2.0 凭据）。与支持单一登录（SSO）的数据源配合使用。

privacyLevel

枚举

隐私级别，在合并来自多个源的数据时相关。

值	说明
None
Organizational
Private
Public

PublishDatasourceToGatewayRequest

Object

将数据源发布到网关请求

名称	类型	说明
connectionDetails	string	连接详细信息
credentialDetails	CredentialDetails	凭据详细信息
dataSourceName	string	数据源名称
dataSourceType	string	数据源类型

通过

Gateways - Create Datasource

权限

所需范围

局限性

URI 参数

请求正文

响应

示例

Azure Analysis Services example

示例请求

示例响应

SQL example

示例请求

示例响应

定义

CredentialDetails

credentialType

encryptedConnection

encryptionAlgorithm

GatewayDatasource

GatewayDatasourceCredentialDetails

privacyLevel

PublishDatasourceToGatewayRequest