Gateways - Update Datasource

Služba:: Power BI REST APIs

Verze rozhraní API:: v1.0

Aktualizuje přihlašovací údaje zadaného zdroje dat ze zadané brány.

Přihlašovací údaje místního zdroje dat musí být šifrované, jak je popsáno v příkladu místních šifrovaných přihlašovacích údajů.

Příklad použití tohoto rozhraní API najdete ve skriptu PowerShellu s přihlašovacími údaji k opravě zdroje dat . Tento skript používá skript PowerShellu uvedený v poznámce níže k šifrování přihlašovacích údajů.

Poznámka:

Pokud chcete šifrovat přihlašovací údaje, přečtěte si téma Konfigurace přihlašovacích údajů pro Power BI prostřednictvím kódu programu a projděte si příklady .NET Core, Javy, Pythonu a PowerShellu .
Přihlašovací údaje systému Windows před šifrováním vypadají jako přihlašovací údaje v příkladu přihlašovacích údajů úrovně Basic.

Při změně z jednotného přihlašování na jiné typy přihlašovacích údajů, například Basic nebo OAuth2, nastavte parametr useEndUserOAuth2Credentials tak false , jak je popsáno v příkladu základních přihlašovacích údajů.

Přihlašovací údaje OAuth 2.0 jsou platné, pokud je zadaný token platný. Při použití typu přihlašovacích údajů OAuth 2.0 postupujte takto:

Správně nastavte cílovou skupinu tokenů OAuth 2.0 podle typu zdroje dat.
Odešle token OAuth 2.0 v datové části, jak je znázorněno v příkladu přihlašovacích údajů OAuth 2.0.
Pokud používáte zdroje dat rozšíření , nenastavujte useCallerAADIdentity na truehodnotu .

Povolení

U místních bran musí mít uživatel oprávnění správce brány.
U cloudových zdrojů dat musí být uživatel vlastníkem zdroje dat. Použití datových sad – Převzetí rozhraní API k přenosu vlastnictví nad zadanou datovou sadou nebo stránkovanými sestavami – Převezměte rozhraní API a přeneste vlastnictví zdrojů dat přes zadanou stránkovanou sestavu.
Toto volání rozhraní API může volat instanční profil. Další informace najdete v tématu: Profily instančního objektu v Power BI Embedded.

Požadovaný obor

Dataset.ReadWrite.All

Omezení

Při nastavování přihlašovacích údajů OAuth se obnovovací token nezačlení, protože se jedná o nastavení přihlašovacích údajů prostřednictvím uživatelského rozhraní ve službě Power BI. Přihlašovací údaje se proto dají použít jenom po dobu jedné hodiny.
Brány virtuální sítě se nepodporují.
Přihlašovací údaje tokenu SAS se podporují jenom s AzureBlobStorage a AzureDataLakeStorage.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
datasourceId	path	True	string (uuid)	ID zdroje dat
gatewayId	path	True	string (uuid)	ID brány. Při použití clusteru brány odkazuje ID brány na primární (první) bránu v clusteru. V takových případech se ID brány podobá ID clusteru brány.

Text požadavku

Name	Vyžadováno	Typ	Description
credentialDetails	True	CredentialDetails	Podrobnosti přihlašovacích údajů

Odpovědi

Name	Typ	Description
200 OK		OK

Příklady

Anonymous credentials example

Basic credentials example

Key credentials example

KeyPair credentials example

OAuth 2.0 credentials example

On-premise encrypted credentials example

SAS Token credentials example

Anonymous credentials example

Ukázkový požadavek

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

Text požadavku

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

Ukázková odpověď

Stavový kód:: 200

Basic credentials example

Ukázkový požadavek

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

Text požadavku

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

Ukázková odpověď

Stavový kód:: 200

Key credentials example

Ukázkový požadavek

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

Text požadavku

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

Ukázková odpověď

Stavový kód:: 200

KeyPair credentials example

Ukázkový požadavek

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

Text požadavku

{
  "credentialDetails": {
    "credentialType": "KeyPair",
    "credentials": "{\"credentialData\":[{\"name\":\"username\",\"value\":\"some-user-name\"},{\"name\":\"privatekey\",\"value\":\"-----BEGIN PRIVATE KEY-----\\nSome-private-key\\n-----END PRIVATE KEY-----\"},{\"name\":\"passphrase\",\"value\":\"\"}]}",
    "encryptedConnection": "NotEncrypted",
    "encryptionAlgorithm": "None",
    "privacyLevel": "None"
  }
}

Ukázková odpověď

Stavový kód:: 200

OAuth 2.0 credentials example

Ukázkový požadavek

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

Text požadavku

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

Ukázková odpověď

Stavový kód:: 200

On-premise encrypted credentials example

Ukázkový požadavek

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

Text požadavku

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

Ukázková odpověď

Stavový kód:: 200

SAS Token credentials example

Ukázkový požadavek

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

Text požadavku

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

Ukázková odpověď

Stavový kód:: 200

Definice

Name	Description
CredentialDetails	Podrobnosti přihlašovacích údajů
credentialType	Typ přihlašovacích údajů ke zdroji dat
encryptedConnection	Určuje, jestli se má šifrovat připojení ke zdroji dat. Volání rozhraní API selže, pokud vyberete šifrování a Power BI nemůže navázat šifrované připojení ke zdroji dat.
encryptionAlgorithm	Šifrovací algoritmus. Pro cloudový zdroj dat zadejte `None`. Pro místní zdroj dat zadejte `RSA-OAEP` a použijte veřejný klíč brány k šifrování přihlašovacích údajů.
privacyLevel	Úroveň ochrany osobních údajů, která je relevantní při kombinování dat z více zdrojů.
UpdateDatasourceRequest	Aktualizace zdroje dat na žádost o bránu

CredentialDetails

Objekt

Podrobnosti přihlašovacích údajů

Name	Typ	Description
credentialType	credentialType	Typ přihlašovacích údajů
credentials	string	Přihlašovací údaje, které závisí na hodnotě credentialType. Další informace najdete v tématu Aktualizace příkladů zdroje dat .
encryptedConnection	encryptedConnection	Určuje, jestli se má šifrovat připojení ke zdroji dat. Volání rozhraní API selže, pokud vyberete šifrování a Power BI nemůže navázat šifrované připojení ke zdroji dat.
encryptionAlgorithm	encryptionAlgorithm	Šifrovací algoritmus. Pro cloudový zdroj dat zadejte `None`. Pro místní zdroj dat zadejte `RSA-OAEP` a použijte veřejný klíč brány k šifrování přihlašovacích údajů.
privacyLevel	privacyLevel	Úroveň ochrany osobních údajů, která je relevantní při kombinování dat z více zdrojů.
useCallerAADIdentity	boolean	Určuje, jestli se identita Azure AD (přihlašovací údaje OAuth 2.0) volajícího rozhraní API (který musí být vlastníkem zdroje dat), použije ke konfiguraci přihlašovacích údajů ke zdroji dat (přístupový token OAuth vlastníka). Obvykle byste použili tento příznak nebo `useEndUserOAuth2Credentials`.
useEndUserOAuth2Credentials	boolean	Určuje, jestli se identita Azure AD koncového uživatele (přihlašovací údaje OAuth 2.0) používá při připojování ke zdroji dat v režimu DirectQuery. Používá se se zdroji dat, které podporují jednotné přihlašování (SSO). Obvykle byste použili tento příznak nebo `useCallerAADIdentity`.

credentialType

Výčet

Typ přihlašovacích údajů ke zdroji dat

Hodnota	Description
Basic
Windows
Anonymous
OAuth2
Key
SAS
KeyPair

encryptedConnection

Výčet

Určuje, jestli se má šifrovat připojení ke zdroji dat. Volání rozhraní API selže, pokud vyberete šifrování a Power BI nemůže navázat šifrované připojení ke zdroji dat.

Hodnota	Description
Encrypted
NotEncrypted

encryptionAlgorithm

Výčet

Šifrovací algoritmus. Pro cloudový zdroj dat zadejte None. Pro místní zdroj dat zadejte RSA-OAEP a použijte veřejný klíč brány k šifrování přihlašovacích údajů.

Hodnota	Description
None
RSA-OAEP

privacyLevel

Výčet

Úroveň ochrany osobních údajů, která je relevantní při kombinování dat z více zdrojů.

Hodnota	Description
None
Public
Organizational
Private

UpdateDatasourceRequest

Objekt

Aktualizace zdroje dat na žádost o bránu

Name	Typ	Description
credentialDetails	CredentialDetails	Podrobnosti přihlašovacích údajů