Gateways - Get Datasources

Service:

Power BI REST APIs

API Version:

v1.0

从指定网关返回数据源的列表。

权限

用户必须具有网关管理员权限。

所需范围

Dataset.ReadWrite.All 或 Dataset.Read.All

限制

不支持虚拟网络 (VNet) 网关。

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

URI 参数

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

响应

名称	类型	说明
200 OK	GatewayDatasources	确定

示例

Example

Sample Request

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

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "252b9de8-d915-4788-aaeb-ec8c2395f970",
      "gatewayId": "1f69e798-5852-4fdd-ab01-33bb14b6e934",
      "datasourceType": "Sql",
      "connectionDetails": "{\"server\":\"localSQL\",\"database\":\"salesDB\"}",
      "credentialType": "Windows",
      "datasourceName": "SQL Datasource"
    },
    {
      "id": "91f8aec2-4b32-476f-909b-3241999620ec",
      "gatewayId": "1f69e798-5852-4fdd-ab01-33bb14b6e934",
      "datasourceType": "AnalysisServices",
      "connectionDetails": "{\"server\":\"localAS\",\"database\":\"marketingDB\"}",
      "credentialType": "Windows",
      "datasourceName": "AS Datasource"
    }
  ]
}

定义

名称	说明
credentialType	数据源凭据的类型
GatewayDatasource	Power BI 网关数据源
GatewayDatasourceCredentialDetails	数据源凭据详细信息
GatewayDatasources	Power BI 网关数据源集合的 OData 响应包装器

credentialType

数据源凭据的类型

名称	类型	说明
Anonymous	string
Basic	string
Key	string
OAuth2	string
SAS	string
Windows	string

GatewayDatasource

Power BI 网关数据源

名称	类型	说明
connectionDetails	string	JSON 格式的连接详细信息
credentialDetails	GatewayDatasourceCredentialDetails	需要更新的数据源的连接详细信息。 当数据集具有多个数据源时，连接详细信息是必需的。
credentialType	credentialType	数据源凭据的类型
datasourceName	string	数据源的名称。
datasourceType	string	数据源的类型。 数据源的 API 名称 ActiveDirectory AdobeAnalytics AdoDotNet AnalysisServices AzureBlobs AzureDataLakeStorage AzureMarketplace AzureTables BizTalk CDPA CustomConnector CustomHttpApi DB2 Essbase EventHub Excel Exchange 分机 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 Web
gatewayId	string	关联的网关 ID。 使用网关群集时，网关 ID 是指群集中第一个) 网关的主 (，类似于网关群集 ID。
id	string	数据源的唯一 ID

GatewayDatasourceCredentialDetails

数据源凭据详细信息

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

GatewayDatasources

Power BI 网关数据源集合的 OData 响应包装器

名称	类型	说明
odata.context	string	OData 上下文
value	GatewayDatasource[]	网关数据源列表