Gateways - Update Datasource

Aktualisiert die Anmeldeinformationen der angegebenen Datenquelle vom angegebenen Gateway.

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

Ein Beispiel für die Verwendung dieser API finden Sie im PowerShell-Skript " Patch Datasource-Anmeldeinformationen ". Dieses Skript verwendet das in der nachstehenden Notiz erwähnte PowerShell-Skript zum Verschlüsseln der Anmeldeinformationen.

Wenn Sie vom einmaligen Anmelden zu anderen Anmeldeinformationstypen wechseln, zBasic. B. oder OAuth2, legen Sie den Parameter useEndUserOAuth2Credentials wie im Beispiel "falseStandardanmeldeinformationen" beschrieben fest.

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-Tokengruppe gemäß 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 diese Option nicht useCallerAADIdentity fest true.

Erlaubnisse

• Bei lokalen Gateways muss der Benutzer über Gatewayadministratorberechtigungen verfügen.
• Bei Clouddatenquellen muss der Benutzer der Besitzer der Datenquelle sein. Verwenden Von Datasets – Übernahme-API zum Übertragen des Besitzes über 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 integriert, da es beim Festlegen von Anmeldeinformationen über die Benutzeroberfläche im Power BI-Dienst erfolgt. Daher können Anmeldeinformationen nur für eine Stunde verwendet werden.
• VNet-Gateways (Virtual Network) 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

Anforderungstext

Antworten

Beispiele

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"
  }
}

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"
  }
}

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"
  }
}

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"
  }
}

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"
  }
}

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"
  }
}

Definitionen

CredentialDetails

Die 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 Nonefür eine Clouddatenquelle an. 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 Datenschutzstufe, die beim Kombinieren von Daten aus mehreren Quellen relevant ist.

UpdateDatasourceRequest

Eine Aktualisierungsdatenquelle für Gatewayanforderung