Gateways - Create Datasource

リファレンス

Service:: Power BI REST APIs

API Version:: 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

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

定義

名前	説明
CredentialDetails	資格情報の詳細
credentialType	データソース資格情報の種類
encryptedConnection	データソース接続を暗号化するかどうか。暗号化を選択し、Power BI がデータソースとの暗号化された接続を確立できない場合、API 呼び出しは失敗します。
encryptionAlgorithm	暗号化アルゴリズム。クラウドデータソースの場合は、を指定します `None`。オンプレミスのデータソースの場合は、ゲートウェイ公開キーを指定 `RSA-OAEP` して使用して資格情報を暗号化します。
GatewayDatasource	Power BI ゲートウェイデータソース
GatewayDatasourceCredentialDetails	データソースの資格情報の詳細
privacyLevel	プライバシーレベル。複数のソースのデータを組み合わせる場合に関連します。
PublishDatasourceToGatewayRequest	ゲートウェイ要求にデータソースを発行する

CredentialDetails

資格情報の詳細

名前	型	説明
credentialType	credentialType	新しい資格情報の種類
credentials	string	'credentialType' 値に依存する資格情報。詳細については、「データソースの例を更新する」を参照してください。
encryptedConnection	encryptedConnection	データソース接続を暗号化するかどうか。暗号化を選択し、Power BI がデータソースとの暗号化された接続を確立できない場合、API 呼び出しは失敗します。
encryptionAlgorithm	encryptionAlgorithm	暗号化アルゴリズム。クラウドデータソースの場合は、を指定します `None`。オンプレミスのデータソースの場合は、ゲートウェイ公開キーを指定 `RSA-OAEP` して使用して資格情報を暗号化します。
privacyLevel	privacyLevel	プライバシーレベル。複数のソースのデータを組み合わせる場合に関連します。
useCallerAADIdentity	boolean	API 呼び出し元 (データソース所有者である必要があります) の Azure AD ID (OAuth 2.0 資格情報) を使用して、データソース資格情報 (所有者 OAuth アクセストークン) を構成するかどうか。通常、このフラグまたはを使用します `useEndUserOAuth2Credentials`。
useEndUserOAuth2Credentials	boolean	DirectQuery モードでデータソースに接続するときに、エンドユーザーの Azure AD ID (OAuth 2.0 資格情報) を使用するかどうか。シングルサインオン (SSO) をサポートするデータソースでを使用します。通常、このフラグまたはを使用します `useCallerAADIdentity`。

credentialType

データソース資格情報の種類

名前	型	説明
Anonymous	string
Basic	string
Key	string
OAuth2	string
SAS	string
Windows	string

encryptedConnection

データソース接続を暗号化するかどうか。暗号化を選択し、Power BI がデータソースとの暗号化された接続を確立できない場合、API 呼び出しは失敗します。

名前	型	説明
Encrypted	string
NotEncrypted	string

encryptionAlgorithm

暗号化アルゴリズム。クラウドデータソースの場合は、を指定します None。オンプレミスのデータソースの場合は、ゲートウェイ公開キーを指定 RSA-OAEP して使用して資格情報を暗号化します。

名前	型	説明
None	string
RSA-OAEP	string

GatewayDatasource

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	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 と似ています。

string

データソースの一意の ID

GatewayDatasourceCredentialDetails

データソースの資格情報の詳細

名前	型	説明
useEndUserOAuth2Credentials	boolean	DirectQuery モードでデータソースに接続するときに、エンドユーザーの Azure AD ID (OAuth 2.0 資格情報) を使用するかどうか。シングルサインオン (SSO) をサポートするデータソースでを使用します。

privacyLevel

プライバシーレベル。複数のソースのデータを組み合わせる場合に関連します。

名前	型	説明
None	string
Organizational	string
Private	string
Public	string

PublishDatasourceToGatewayRequest

ゲートウェイ要求にデータソースを発行する

名前	型	説明
connectionDetails	string	接続の詳細
credentialDetails	CredentialDetails	資格情報の詳細
dataSourceName	string	データソース名
dataSourceType	string	データソースの種類

次の方法で共有

Gateways - Create Datasource

アクセス許可

必要なスコープ

制限事項

URI パラメーター

要求本文

応答

例

Azure Analysis Services example

Sample Request

Sample Response

SQL example

Sample Request

Sample Response

定義

CredentialDetails

credentialType

encryptedConnection

encryptionAlgorithm

GatewayDatasource

GatewayDatasourceCredentialDetails

privacyLevel

PublishDatasourceToGatewayRequest

その他のリソース