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	OK

例

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 ファイル Folder 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 ID (OAuth 2.0 資格情報) を使用するかどうか。 シングル サインオン (SSO) をサポートするデータ ソースで使用します。

GatewayDatasources

Power BI ゲートウェイ データ ソース コレクションの OData 応答ラッパー

名前	型	説明
odata.context	string	OData コンテキスト
value	GatewayDatasource[]	ゲートウェイ データ ソースの一覧