Gateways - Create Datasource
指定したオンプレミス ゲートウェイに新しいデータ ソースを作成します。
オンプレミスのデータ ソース資格情報を暗号化する必要があります。 パラメーターは 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 パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
gateway
|
path | True |
string uuid |
ゲートウェイ ID。 ゲートウェイ クラスターを使用する場合、ゲートウェイ ID はクラスター内のプライマリ (最初の) ゲートウェイを参照します。 このような場合、ゲートウェイ ID はゲートウェイ クラスター ID に似ています。 |
要求本文
名前 | 必須 | 型 | 説明 |
---|---|---|---|
connectionDetails | True |
string |
接続の詳細 |
credentialDetails | True |
資格情報の詳細 |
|
dataSourceName | True |
string |
データ ソース名 |
dataSourceType | True |
string |
データ ソースの種類 |
応答
名前 | 型 | 説明 |
---|---|---|
201 Created |
作成済み |
例
Azure Analysis Services example
Sample Request
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"
}
}
Sample Response
SQL example
Sample Request
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"
}
}
Sample Response
定義
名前 | 説明 |
---|---|
Credential |
資格情報の詳細 |
credential |
データ ソース資格情報の種類 |
encrypted |
データ ソース接続を暗号化するかどうか。 暗号化を選択し、Power BI がデータ ソースとの暗号化された接続を確立できない場合、API 呼び出しは失敗します。 |
encryption |
暗号化アルゴリズム。 クラウド データ ソースの場合は、 を指定します |
Gateway |
Power BI ゲートウェイ データ ソース |
Gateway |
データ ソースの資格情報の詳細 |
privacy |
プライバシー レベル。複数のソースのデータを組み合わせる場合に関連します。 |
Publish |
ゲートウェイ要求にデータ ソースを発行する |
CredentialDetails
資格情報の詳細
名前 | 型 | 説明 |
---|---|---|
credentialType |
新しい資格情報の種類 |
|
credentials |
string |
'credentialType' 値に依存する資格情報。 詳細については、「データソースの 例を更新 する」を参照してください。 |
encryptedConnection |
データ ソース接続を暗号化するかどうか。 暗号化を選択し、Power BI がデータ ソースとの暗号化された接続を確立できない場合、API 呼び出しは失敗します。 |
|
encryptionAlgorithm |
暗号化アルゴリズム。 クラウド データ ソースの場合は、 を指定します |
|
privacyLevel |
プライバシー レベル。複数のソースのデータを組み合わせる場合に関連します。 |
|
useCallerAADIdentity |
boolean |
API 呼び出し元 (データ ソース所有者である必要があります) の Azure AD ID (OAuth 2.0 資格情報) を使用して、データ ソース資格情報 (所有者 OAuth アクセス トークン) を構成するかどうか。 通常、このフラグまたは を使用します |
useEndUserOAuth2Credentials |
boolean |
DirectQuery モードでデータ ソースに接続するときに、エンドユーザーの Azure AD ID (OAuth 2.0 資格情報) を使用するかどうか。 シングル サインオン (SSO) をサポートするデータ ソースで を使用します。 通常、このフラグまたは を使用します |
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 |
更新が必要なデータ ソースの接続の詳細。 データセットに複数のデータ ソースがある場合は、接続の詳細が必須です。 |
||||||||||||||||||||||||||||||||||||||||||||||||||||
credentialType |
データ ソース資格情報の種類 |
||||||||||||||||||||||||||||||||||||||||||||||||||||
datasourceName |
string |
データ ソースの名前 |
|||||||||||||||||||||||||||||||||||||||||||||||||||
datasourceType |
string |
データ ソースの種類。
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
gatewayId |
string |
関連付けられているゲートウェイ ID。 ゲートウェイ クラスターを使用する場合、ゲートウェイ 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 |
資格情報の詳細 |
|
dataSourceName |
string |
データ ソース名 |
dataSourceType |
string |
データ ソースの種類 |