次の方法で共有

Gateways - Update Datasource

サービス:
Power BI REST APIs
API バージョン:
v1.0

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

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

この API の使用例については、 Patch Datasource Credentials PowerShell スクリプトを参照してください。このスクリプトでは、資格情報を暗号化するために以下のメモに記載されている PowerShell スクリプトを使用します。

注

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

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

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

Permissions

  • オンプレミス ゲートウェイでは、ユーザーはゲートウェイ管理者のアクセス許可を持っている必要があります。
  • クラウド データ ソースの場合、ユーザーはデータ ソースの所有者である必要があります。 データセットを使用する - 指定したデータセットまたはページ分割されたレポートに所有権を譲渡する場合は TAKE Over API - 指定されたページ分割されたレポートを介してデータ ソースの所有権を転送する場合は、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

要求のサンプル

PATCH https://api.powerbi.com/v1.0/myorg/gateways/1f69e798-5852-4fdd-ab01-33bb14b6e934/datasources/252b9de8-d915-4788-aaeb-ec8c2395f970
要求本文
{
  "credentialDetails": {
    "credentialType": "Anonymous",
    "credentials": "{\"credentialData\":\"\"}",
    "encryptedConnection": "Encrypted",
    "encryptionAlgorithm": "None",
    "privacyLevel": "None"
  }
}

応答のサンプル

状態コード:
200

Basic credentials example

要求のサンプル

PATCH https://api.powerbi.com/v1.0/myorg/gateways/1f69e798-5852-4fdd-ab01-33bb14b6e934/datasources/252b9de8-d915-4788-aaeb-ec8c2395f970
要求本文
{
  "credentialDetails": {
    "credentialType": "Basic",
    "credentials": "{\"credentialData\":[{\"name\":\"username\", \"value\":\"john\"},{\"name\":\"password\", \"value\":\"*****\"}]}",
    "encryptedConnection": "Encrypted",
    "encryptionAlgorithm": "None",
    "privacyLevel": "None",
    "useEndUserOAuth2Credentials": "False"
  }
}

応答のサンプル

状態コード:
200

Key credentials example

要求のサンプル

PATCH https://api.powerbi.com/v1.0/myorg/gateways/1f69e798-5852-4fdd-ab01-33bb14b6e934/datasources/252b9de8-d915-4788-aaeb-ec8c2395f970
要求本文
{
  "credentialDetails": {
    "credentialType": "Key",
    "credentials": "{\"credentialData\":[{\"name\":\"key\", \"value\":\"ec....LA=\"}]}",
    "encryptedConnection": "Encrypted",
    "encryptionAlgorithm": "None",
    "privacyLevel": "None"
  }
}

応答のサンプル

状態コード:
200

OAuth 2.0 credentials example

要求のサンプル

PATCH https://api.powerbi.com/v1.0/myorg/gateways/1f69e798-5852-4fdd-ab01-33bb14b6e934/datasources/252b9de8-d915-4788-aaeb-ec8c2395f970
要求本文
{
  "credentialDetails": {
    "credentialType": "OAuth2",
    "credentials": "{\"credentialData\":[{\"name\":\"accessToken\", \"value\":\"eyJ0....fwtQ\"}]}",
    "encryptedConnection": "Encrypted",
    "encryptionAlgorithm": "None",
    "privacyLevel": "None"
  }
}

応答のサンプル

状態コード:
200

On-premise encrypted credentials example

要求のサンプル

PATCH https://api.powerbi.com/v1.0/myorg/gateways/1f69e798-5852-4fdd-ab01-33bb14b6e934/datasources/252b9de8-d915-4788-aaeb-ec8c2395f970
要求本文
{
  "credentialDetails": {
    "credentialType": "Windows",
    "credentials": "AB....EF==",
    "encryptedConnection": "Encrypted",
    "encryptionAlgorithm": "RSA-OAEP",
    "privacyLevel": "None"
  }
}

応答のサンプル

状態コード:
200

SAS Token credentials example

要求のサンプル

PATCH https://api.powerbi.com/v1.0/myorg/gateways/1f69e798-5852-4fdd-ab01-33bb14b6e934/datasources/252b9de8-d915-4788-aaeb-ec8c2395f970
要求本文
{
  "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"
  }
}

応答のサンプル

状態コード:
200

定義

名前 説明
CredentialDetails

資格情報の詳細
credentialType

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

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

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

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

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

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

列挙

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

値 説明
Basic
Windows
Anonymous
OAuth2
Key
SAS

encryptedConnection

列挙

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

値 説明
Encrypted
NotEncrypted

encryptionAlgorithm

列挙

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

値 説明
None
RSA-OAEP

privacyLevel

列挙

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

値 説明
None
Public
Organizational
Private

UpdateDatasourceRequest

Object

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

名前 型 説明
credentialDetails

CredentialDetails

資格情報の詳細