Gateways - Update Datasource

Reference

Service:: Power BI REST APIs

API Version:: v1.0

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

Přihlašovací údaje k místnímu zdroji dat musí být šifrované, jak je popsáno v příkladu s místními šifrovanými přihlašovacími údaji.

Poznámka

Pokud chcete přihlašovací údaje zašifrovat, 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 encryptCredentials .NET Core, Java a Python .
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ů, jako Basic je nebo OAuth2, nastavte parametr useEndUserOAuth2Credentials na hodnotu , 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:

Nastavte cílovou skupinu tokenu OAuth 2.0 správně podle typu zdroje dat.
Odešlete 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 .

Oprávnění

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. Pomocí rozhraní API Datové sady – Převzetí přeneste vlastnictví zadané datové sady nebo stránkovaných sestav – Převezměte rozhraní API k přenosu vlastnictví zdrojů dat přes zadanou stránkovanou sestavu.
Toto volání rozhraní API může volat profil instančního objektu. Další informace najdete v tématu Profily instančních objektů 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í jako při nastavování přihlašovacích údajů prostřednictvím uživatelského rozhraní v služba Power BI. Přihlašovací údaje se proto dají používat jenom jednu hodinu.
Brány virtuální sítě (VNet) se nepodporují.
Přihlašovací údaje tokenu SAS se podporují pouze 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. Pokud používáte cluster bran, ID brány odkazuje 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 o přihlašovacích údajích

Odpovědi

Name	Typ	Description
200 OK		OK

Příklady

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

Definice

Name	Description
CredentialDetails	Podrobnosti o přihlašovacích údajích
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 nebude moct navázat šifrované připojení ke zdroji dat.
encryptionAlgorithm	Šifrovací algoritmus. Pro cloudový zdroj dat zadejte `None`. V případě místního zdroje 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	Žádost o aktualizaci zdroje dat na bránu

CredentialDetails

Podrobnosti o přihlašovacích údajích

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 Příklady aktualizace 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 nebude moct navázat šifrované připojení ke zdroji dat.
encryptionAlgorithm	encryptionAlgorithm	Šifrovací algoritmus. Pro cloudový zdroj dat zadejte `None`. V případě místního zdroje 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	Jestli se ke konfiguraci přihlašovacích údajů ke zdroji dat (přístupový token OAuth 2.0) použije Azure AD identita (přihlašovací údaje OAuth 2.0) volajícího rozhraní API (který musí být vlastníkem zdroje dat). Obvykle byste použili buď tento příznak, nebo `useEndUserOAuth2Credentials`.
useEndUserOAuth2Credentials	boolean	Určuje, jestli se při připojování ke zdroji dat v režimu DirectQuery používá identita koncového Azure AD uživatele (přihlašovací údaje OAuth 2.0). Používá se se zdroji dat, které podporují jednotné přihlašování (SSO). Obvykle byste použili buď tento příznak, nebo `useCallerAADIdentity`.

credentialType

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

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

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 nebude moct navázat šifrované připojení ke zdroji dat.

Name	Typ	Description
Encrypted	string
NotEncrypted	string

encryptionAlgorithm

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

Name	Typ	Description
None	string
RSA-OAEP	string

privacyLevel

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

Name	Typ	Description
None	string
Organizational	string
Private	string
Public	string

UpdateDatasourceRequest

Žádost o aktualizaci zdroje dat na bránu

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

Sdílet prostřednictvím

Gateways - Update Datasource

Oprávnění

Požadovaný obor

Omezení

Parametry identifikátoru URI

Text požadavku

Odpovědi

Příklady

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

Definice

CredentialDetails

credentialType

encryptedConnection

encryptionAlgorithm

privacyLevel

UpdateDatasourceRequest

Další materiály