Gateways - Update Datasource

リファレンス

Service:: Power BI REST APIs

API Version:: v1.0

指定したゲートウェイから、指定したデータソースの資格情報を更新します。

オンプレミスの暗号化された資格情報の例で説明されているように、オンプレミスのデータソースの資格情報を暗号化する必要があります。

注意

資格情報を暗号化するには、「Power BI の資格情報をプログラムで構成する」を参照し、EncryptCredentials .NET Core、 Java 、 Python の例を確認してください。
暗号化前の Windows 資格情報は、Basic 資格情報の資格情報の例の資格情報のようになります。

シングルサインオンから、または OAuth2などのBasic他の資格情報の種類に変更する場合は、基本資格情報の例で説明されているように、パラメーターuseEndUserOAuth2Credentialsをにfalse設定します。

OAuth 2.0 資格情報は、指定されたトークンが有効である限り有効です。 OAuth 2.0 資格情報の種類を使用する場合は、次の操作を行います。

データソースの種類に従って、OAuth 2.0 トークンの対象ユーザーを正しく設定します。
OAuth 2.0 資格情報の例に示すように、ペイロードで OAuth 2.0 トークンを送信します。
拡張機能データソースを使用している場合は、をにtrue設定useCallerAADIdentityしないでください。

アクセス許可

オンプレミスゲートウェイでは、ユーザーはゲートウェイ管理者のアクセス許可を持っている必要があります。
クラウドデータソースでは、ユーザーがデータソース所有者である必要があります。データセットを使用する - 指定したデータセットまたはページ分割されたレポートの所有権を譲渡する TAKE Over API - Take Over API を使用して、指定されたページ分割されたレポートに対してデータソースの所有権を転送します。
この API 呼び出しは、サービスプリンシパルプロファイルによって呼び出すことができます。詳細については、「Power BI Embeddedのサービスプリンシパルプロファイル」を参照してください。

必要なスコープ

Dataset.ReadWrite.All

制限事項

OAuth 資格情報を設定する場合、更新トークンは、Power BI サービスの UI を介して資格情報を設定する場合と同様に組み込まれません。そのため、資格情報は 1 時間しか使用できません。
仮想ネットワーク (VNet) ゲートウェイはサポートされていません。
SAS トークンの資格情報は、AzureBlobStorage と AzureDataLakeStorage でのみサポートされます。

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

URI パラメーター

名前	/	必須	型	説明
datasourceId	path	True	string uuid	データソース ID
gatewayId	path	True	string uuid	ゲートウェイ ID。ゲートウェイクラスターを使用する場合、ゲートウェイ ID はクラスター内のプライマリ (最初の) ゲートウェイを参照します。このような場合、ゲートウェイ ID はゲートウェイクラスター ID に似ています。

要求本文

名前	必須	型	説明
credentialDetails	True	CredentialDetails	資格情報の詳細

応答

名前	型	説明
200 OK		OK

例

Anonymous credentials example

Basic credentials example

Key credentials example

OAuth 2.0 credentials example

On-premise encrypted credentials example

SAS Token credentials example

Anonymous credentials example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/gateways/1f69e798-5852-4fdd-ab01-33bb14b6e934/datasources/252b9de8-d915-4788-aaeb-ec8c2395f970

Request Body

{
  "credentialDetails": {
    "credentialType": "Anonymous",
    "credentials": "{\"credentialData\":\"\"}",
    "encryptedConnection": "Encrypted",
    "encryptionAlgorithm": "None",
    "privacyLevel": "None"
  }
}

Sample Response

Status code:: 200

Basic credentials example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/gateways/1f69e798-5852-4fdd-ab01-33bb14b6e934/datasources/252b9de8-d915-4788-aaeb-ec8c2395f970

Request Body

{
  "credentialDetails": {
    "credentialType": "Basic",
    "credentials": "{\"credentialData\":[{\"name\":\"username\", \"value\":\"john\"},{\"name\":\"password\", \"value\":\"*****\"}]}",
    "encryptedConnection": "Encrypted",
    "encryptionAlgorithm": "None",
    "privacyLevel": "None",
    "useEndUserOAuth2Credentials": "False"
  }
}

Sample Response

Status code:: 200

Key credentials example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/gateways/1f69e798-5852-4fdd-ab01-33bb14b6e934/datasources/252b9de8-d915-4788-aaeb-ec8c2395f970

Request Body

{
  "credentialDetails": {
    "credentialType": "Key",
    "credentials": "{\"credentialData\":[{\"name\":\"key\", \"value\":\"ec....LA=\"}]}",
    "encryptedConnection": "Encrypted",
    "encryptionAlgorithm": "None",
    "privacyLevel": "None"
  }
}

Sample Response

Status code:: 200

OAuth 2.0 credentials example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/gateways/1f69e798-5852-4fdd-ab01-33bb14b6e934/datasources/252b9de8-d915-4788-aaeb-ec8c2395f970

Request Body

{
  "credentialDetails": {
    "credentialType": "OAuth2",
    "credentials": "{\"credentialData\":[{\"name\":\"accessToken\", \"value\":\"eyJ0....fwtQ\"}]}",
    "encryptedConnection": "Encrypted",
    "encryptionAlgorithm": "None",
    "privacyLevel": "None"
  }
}

Sample Response

Status code:: 200

On-premise encrypted credentials example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/gateways/1f69e798-5852-4fdd-ab01-33bb14b6e934/datasources/252b9de8-d915-4788-aaeb-ec8c2395f970

Request Body

{
  "credentialDetails": {
    "credentialType": "Windows",
    "credentials": "AB....EF==",
    "encryptedConnection": "Encrypted",
    "encryptionAlgorithm": "RSA-OAEP",
    "privacyLevel": "None"
  }
}

Sample Response

Status code:: 200

SAS Token credentials example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/gateways/1f69e798-5852-4fdd-ab01-33bb14b6e934/datasources/252b9de8-d915-4788-aaeb-ec8c2395f970

Request Body

{
  "credentialDetails": {
    "credentialType": "SAS",
    "credentials": "{\"credentialData\":[{\"name\":\"token\", \"value\":\"sp=rl&st=2023-01-16T09:37:25Z&se=2023...J0%2F0YVkjKxPtEwsyn\"}]}",
    "encryptedConnection": "Encrypted",
    "encryptionAlgorithm": "None",
    "privacyLevel": "None"
  }
}

Sample Response

Status code:: 200

定義

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

CredentialDetails

資格情報の詳細

名前	型	説明
credentialType	credentialType	新しい資格情報の種類
credentials	string	'credentialType' 値に依存する資格情報。詳細については、「 Update Datasource examples」を参照してください。
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

privacyLevel

複数のソースからのデータを結合する場合に関連するプライバシーレベル。

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

UpdateDatasourceRequest

ゲートウェイ要求へのデータソースの更新

名前	型	説明
credentialDetails	CredentialDetails	資格情報の詳細

次の方法で共有

Gateways - Update Datasource

アクセス許可

必要なスコープ

制限事項

URI パラメーター

要求本文

応答

例

Anonymous credentials example

Sample Request

Sample Response

Basic credentials example

Sample Request

Sample Response

Key credentials example

Sample Request

Sample Response

OAuth 2.0 credentials example

Sample Request

Sample Response

On-premise encrypted credentials example

Sample Request

Sample Response

SAS Token credentials example

Sample Request

Sample Response

定義

CredentialDetails

credentialType

encryptedConnection

encryptionAlgorithm

privacyLevel

UpdateDatasourceRequest

その他のリソース