Gateways - Update Datasource

Referenz

Service:: Power BI REST APIs

API Version:: v1.0

Updates die Anmeldeinformationen der angegebenen Datenquelle aus dem angegebenen Gateway.

Anmeldeinformationen für lokale Datenquellen müssen verschlüsselt werden, wie im Beispiel für lokale verschlüsselte Anmeldeinformationen beschrieben.

Hinweis

Informationen zum Verschlüsseln von Anmeldeinformationen finden Sie unter Programmgesteuertes Konfigurieren von Anmeldeinformationen für Power BI, und lesen Sie die Beispiele für EncryptCredentials .NET Core, Java und Python .
Windows-Anmeldeinformationen vor der Verschlüsselung sehen wie die Anmeldeinformationen im Beispiel für Standardanmeldeinformationen aus.

Wenn Sie vom einmaligen Anmelden zu anderen Anmeldeinformationstypen wie oder OAuth2wechseln, Basic legen Sie den Parameter useEndUserOAuth2Credentials auf festfalse, wie im Beispiel für grundlegende Anmeldeinformationen beschrieben.

OAuth 2.0-Anmeldeinformationen sind gültig, solange das bereitgestellte Token gültig ist. Gehen Sie bei Verwendung des OAuth 2.0-Anmeldeinformationstyps wie folgt vor:

Legen Sie die OAuth 2.0-Tokenzielgruppe entsprechend dem Datenquellentyp richtig fest.
Senden Sie das OAuth 2.0-Token in der Nutzlast, wie im Beispiel für OAuth 2.0-Anmeldeinformationen gezeigt.
Wenn Sie Erweiterungsdatenquellen verwenden, legen Sie nicht auf truefestuseCallerAADIdentity.

Berechtigungen

Bei lokalen Gateways muss der Benutzer über Gatewayadministratorberechtigungen verfügen.
Bei Clouddatenquellen muss der Benutzer der Datenquellenbesitzer sein. Verwenden von Datasets – Übernehmen der API zum Übertragen des Besitzes für das angegebene Dataset oder paginierte Berichte – Übernehmen Sie die API, um den Besitz der Datenquellen über den angegebenen paginierten Bericht zu übertragen.
Dieser API-Aufruf kann von einem Dienstprinzipalprofil aufgerufen werden. Weitere Informationen finden Sie unter Dienstprinzipalprofile in Power BI Embedded.

Erforderlicher Bereich

Dataset.ReadWrite.All

Einschränkungen

Beim Festlegen von OAuth-Anmeldeinformationen wird ein Aktualisierungstoken nicht wie beim Festlegen von Anmeldeinformationen über die Benutzeroberfläche in Power BI-Dienst integriert. Daher können Anmeldeinformationen nur für eine Stunde verwendet werden.
Gateways für virtuelle Netzwerke (VNET) werden nicht unterstützt.
SAS-Tokenanmeldeinformationen werden nur mit AzureBlobStorage und AzureDataLakeStorage unterstützt.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
datasourceId	path	True	string uuid	Die Datenquellen-ID
gatewayId	path	True	string uuid	Die Gateway-ID. Bei Verwendung eines Gatewayclusters bezieht sich die Gateway-ID auf das primäre (erste) Gateway im Cluster. In solchen Fällen ähnelt die Gateway-ID der Gatewaycluster-ID.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
credentialDetails	True	CredentialDetails	Details zu Anmeldeinformationen

Antworten

Name	Typ	Beschreibung
200 OK		OK

Beispiele

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

Definitionen

Name	Beschreibung
CredentialDetails	Details zu Anmeldeinformationen
credentialType	Der Typ der Datenquellenanmeldeinformationen
encryptedConnection	Gibt an, ob die Datenquellenverbindung verschlüsselt werden soll. Der API-Aufruf schlägt fehl, wenn Sie verschlüsselung auswählen und Power BI keine verschlüsselte Verbindung mit der Datenquelle herstellen kann.
encryptionAlgorithm	Der Verschlüsselungsalgorithmus. Geben Sie für eine Clouddatenquelle an `None`. Geben Sie `RSA-OAEP` für eine lokale Datenquelle den öffentlichen Gatewayschlüssel an, und verwenden Sie diesen, um die Anmeldeinformationen zu verschlüsseln.
privacyLevel	Die Datenschutzebene, die bei der Kombination von Daten aus mehreren Quellen relevant ist.
UpdateDatasourceRequest	Eine Updatedatenquelle für eine Gatewayanforderung

CredentialDetails

Details zu Anmeldeinformationen

Name	Typ	Beschreibung
credentialType	credentialType	Der Anmeldeinformationstyp
credentials	string	Die Anmeldeinformationen, die vom Wert "credentialType" abhängen. Weitere Informationen finden Sie unter Beispiele zum Aktualisieren von Datenquellen .
encryptedConnection	encryptedConnection	Gibt an, ob die Datenquellenverbindung verschlüsselt werden soll. Der API-Aufruf schlägt fehl, wenn Sie verschlüsselung auswählen und Power BI keine verschlüsselte Verbindung mit der Datenquelle herstellen kann.
encryptionAlgorithm	encryptionAlgorithm	Der Verschlüsselungsalgorithmus. Geben Sie für eine Clouddatenquelle an `None`. Geben Sie `RSA-OAEP` für eine lokale Datenquelle den öffentlichen Gatewayschlüssel an, und verwenden Sie diesen, um die Anmeldeinformationen zu verschlüsseln.
privacyLevel	privacyLevel	Die Datenschutzebene, die bei der Kombination von Daten aus mehreren Quellen relevant ist.
useCallerAADIdentity	boolean	Gibt an, ob die Azure AD-Identität (OAuth 2.0-Anmeldeinformationen) des API-Aufrufers (der der Datenquellenbesitzer sein muss) zum Konfigurieren von Datenquellenanmeldeinformationen (das OAuth-Zugriffstoken des Besitzers) verwendet wird. In der Regel verwenden Sie entweder dieses Flag oder `useEndUserOAuth2Credentials`.
useEndUserOAuth2Credentials	boolean	Gibt an, ob die Azure AD-Identität des Endbenutzers (OAuth 2.0-Anmeldeinformationen) beim Herstellen einer Verbindung mit der Datenquelle im DirectQuery-Modus verwendet wird. Verwenden Sie für Datenquellen, die einmaliges Anmelden (Single Sign-On, SSO) unterstützen. In der Regel verwenden Sie entweder dieses Flag oder `useCallerAADIdentity`.

credentialType

Der Typ der Datenquellenanmeldeinformationen

Name	Typ	Beschreibung
Anonymous	string
Basic	string
Key	string
OAuth2	string
SAS	string
Windows	string

encryptedConnection

Gibt an, ob die Datenquellenverbindung verschlüsselt werden soll. Der API-Aufruf schlägt fehl, wenn Sie verschlüsselung auswählen und Power BI keine verschlüsselte Verbindung mit der Datenquelle herstellen kann.

Name	Typ	Beschreibung
Encrypted	string
NotEncrypted	string

encryptionAlgorithm

Der Verschlüsselungsalgorithmus. Geben Sie für eine Clouddatenquelle an None. Geben Sie RSA-OAEP für eine lokale Datenquelle den öffentlichen Gatewayschlüssel an, und verwenden Sie diesen, um die Anmeldeinformationen zu verschlüsseln.

Name	Typ	Beschreibung
None	string
RSA-OAEP	string

privacyLevel

Die Datenschutzebene, die bei der Kombination von Daten aus mehreren Quellen relevant ist.

Name	Typ	Beschreibung
None	string
Organizational	string
Private	string
Public	string

UpdateDatasourceRequest

Eine Updatedatenquelle für eine Gatewayanforderung

Name	Typ	Beschreibung
credentialDetails	CredentialDetails	Details zu Anmeldeinformationen

Gateways - Update Datasource

Berechtigungen

Erforderlicher Bereich

Einschränkungen

URI-Parameter

Anforderungstext

Antworten

Beispiele

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

Definitionen

CredentialDetails

credentialType

encryptedConnection

encryptionAlgorithm

privacyLevel

UpdateDatasourceRequest

Zusätzliche Ressourcen