Gateways - Create Datasource

サービス:

Power BI REST APIs

API バージョン:

v1.0

指定したオンプレミス ゲートウェイに新しいデータ ソースを作成します。

オンプレミスのデータ ソースの資格情報を暗号化する必要があります。 encryptedConnection パラメーターは Encrypted に設定する必要があり、資格情報はゲートウェイの公開キーを使用して暗号化する必要があります。

この API の使用例については、「ゲートウェイ DataSource PowerShell スクリプトを作成する」を参照してください。このスクリプトでは、資格情報を暗号化するために以下のメモに記載されている PowerShell スクリプトを使用します。

注意

資格情報を暗号化するには、「プログラムで Power BI 用に 資格情報を構成する」を参照し、.NET Core 、Java、Python、PowerShell の例をEncryptCredentials を確認します。

権限

オンプレミスゲートウェイのみをサポートし、ユーザーはゲートウェイ管理者のアクセス許可を持っている必要があります

必要なスコープ

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 ID (OAuth 2.0 資格情報) を使用して、データ ソース資格情報 (所有者 OAuth アクセス トークン) を構成するかどうか。 通常、このフラグを使用するか、useEndUserOAuth2Credentialsします。
useEndUserOAuth2Credentials	boolean	DirectQuery モードでデータ ソースに接続するときに、エンド ユーザーの Azure AD ID (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	credentialType	資格情報 データ ソースの種類
datasourceName	string	データ ソースの名前
datasourceType	string	データ ソース の種類。 データ ソースの API 名 ActiveDirectory AdobeAnalytics AdoDotNet AnalysisServices AzureBlobs AzureDataLakeStorage AzureMarketplace AzureTables BizTalk CDPA CustomConnector CustomHttpApi DB2 Essbase EventHub エクセル 交換 拡張 Facebook ファイル フォルダー GoogleAnalytics Hdfs HDInsight Informix MQ MySql OData ODBC OleDb オラクル PostgreSQL PowerQueryMashup PubNub セールスフォース SAPBW SAPBWMessageServer SapErp SAPHana SharePoint SharePointDocLib SharePointList SQL (構造化クエリ言語) Sybase Teradata UIFlow ウェブ
gatewayId	string (uuid)	関連付けられているゲートウェイ ID。 ゲートウェイ クラスターを使用する場合、ゲートウェイ ID はクラスター内のプライマリ (最初の) ゲートウェイを参照し、ゲートウェイ クラスター ID と似ています。
id	string (uuid)	データ ソースの一意の ID

GatewayDatasourceCredentialDetails

Object

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

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

privacyLevel

列挙

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

値	説明
None
Organizational
Private
Public

PublishDatasourceToGatewayRequest

Object

ゲートウェイ要求へのデータ ソースの発行

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