Gateways - Update Datasource

Odwołanie

Service:: Power BI REST APIs

API Version:: v1.0

Aktualizacje poświadczenia określonego źródła danych z określonej bramy.

Poświadczenia lokalnego źródła danych muszą być szyfrowane zgodnie z opisem w przykładzie lokalnych zaszyfrowanych poświadczeń.

Uwaga

Aby zaszyfrować poświadczenia, zobacz Konfigurowanie poświadczeń programowo dla usługi Power BI i zapoznaj się z przykładami encryptCredentials .NET Core, Java i Python .
Poświadczenia systemu Windows przed szyfrowaniem wyglądają jak poświadczenia w przykładzie poświadczeń podstawowych.

W przypadku zmiany logowania jednokrotnego na inne typy poświadczeń, takie jak Basic lub OAuth2, ustaw parametr useEndUserOAuth2Credentials na false zgodnie z opisem w przykładzie Podstawowe poświadczenia.

Poświadczenia protokołu OAuth 2.0 są prawidłowe, o ile podany token jest prawidłowy. W przypadku korzystania z typu poświadczeń OAuth 2.0 wykonaj następujące czynności:

Ustaw prawidłowo odbiorców tokenu OAuth 2.0 zgodnie z typem źródła danych.
Wyślij token OAuth 2.0 w ładunku, jak pokazano w przykładzie poświadczeń OAuth 2.0.
Jeśli używasz źródeł danych rozszerzenia , nie ustaw wartości useCallerAADIdentitytrue.

Uprawnienia

W przypadku bram lokalnych użytkownik musi mieć uprawnienia administratora bramy.
W przypadku źródeł danych w chmurze użytkownik musi być właścicielem źródła danych. Użyj zestawów danych — przejmij interfejs API , aby przenieść własność określonego zestawu danych lub raportów podzielonych na strony — przejmij własność interfejsu API w celu przeniesienia własności źródeł danych za pośrednictwem określonego raportu podzielonego na strony.
To wywołanie interfejsu API może być wywoływane przez profil jednostki usługi. Aby uzyskać więcej informacji, zobacz: Profile jednostki usługi w Power BI Embedded.

Zakres wymagany

Dataset.ReadWrite.All

Ograniczenia

Podczas ustawiania poświadczeń protokołu OAuth token odświeżania nie jest uwzględniany, ponieważ podczas ustawiania poświadczeń za pośrednictwem interfejsu użytkownika w usługa Power BI. W związku z tym poświadczenia mogą być używane tylko przez jedną godzinę.
Bramy sieci wirtualnej nie są obsługiwane.
Poświadczenia tokenu SAS są obsługiwane tylko w usługach AzureBlobStorage i AzureDataLakeStorage.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
datasourceId	path	True	string uuid	Identyfikator źródła danych
gatewayId	path	True	string uuid	Identyfikator bramy. W przypadku korzystania z klastra bramy identyfikator bramy odwołuje się do bramy podstawowej (pierwszej) w klastrze. W takich przypadkach identyfikator bramy jest podobny do identyfikatora klastra bramy.

Treść żądania

Nazwa	Wymagane	Typ	Opis
credentialDetails	True	CredentialDetails	Szczegóły poświadczeń

Odpowiedzi

Nazwa	Typ	Opis
200 OK		OK

Przykłady

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

Definicje

Nazwa	Opis
CredentialDetails	Szczegóły poświadczeń
credentialType	Typ poświadczeń źródła danych
encryptedConnection	Czy szyfrować połączenie ze źródłem danych. Wywołanie interfejsu API zakończy się niepowodzeniem, jeśli wybierzesz szyfrowanie, a usługa Power BI nie może nawiązać zaszyfrowanego połączenia ze źródłem danych.
encryptionAlgorithm	Algorytm szyfrowania. W przypadku źródła danych w chmurze określ wartość `None`. W przypadku lokalnego źródła danych określ `RSA-OAEP` klucz publiczny bramy i użyj go do zaszyfrowania poświadczeń.
privacyLevel	Poziom prywatności, który jest istotny podczas łączenia danych z wielu źródeł.
UpdateDatasourceRequest	Żądanie aktualizacji źródła danych do bramy

CredentialDetails

Szczegóły poświadczeń

Nazwa	Typ	Opis
credentialType	credentialType	Typ poświadczeń
credentials	string	Poświadczenia, które zależą od wartości "credentialType". Aby uzyskać więcej informacji, zobacz Update Datasource examples (Aktualizowanie przykładów źródła danych).
encryptedConnection	encryptedConnection	Czy szyfrować połączenie ze źródłem danych. Wywołanie interfejsu API zakończy się niepowodzeniem, jeśli wybierzesz szyfrowanie, a usługa Power BI nie może nawiązać zaszyfrowanego połączenia ze źródłem danych.
encryptionAlgorithm	encryptionAlgorithm	Algorytm szyfrowania. W przypadku źródła danych w chmurze określ wartość `None`. W przypadku lokalnego źródła danych określ `RSA-OAEP` klucz publiczny bramy i użyj go do zaszyfrowania poświadczeń.
privacyLevel	privacyLevel	Poziom prywatności, który jest istotny podczas łączenia danych z wielu źródeł.
useCallerAADIdentity	boolean	Określa, czy tożsamość Azure AD (poświadczenia OAuth 2.0) obiektu wywołującego interfejs API (który musi być właścicielem źródła danych) będzie używana do konfigurowania poświadczeń źródła danych (tokenu dostępu właściciela OAuth). Zazwyczaj należy użyć tej flagi lub `useEndUserOAuth2Credentials`.
useEndUserOAuth2Credentials	boolean	Określa, czy tożsamość użytkownika końcowego Azure AD (poświadczenia protokołu OAuth 2.0) jest używana podczas nawiązywania połączenia ze źródłem danych w trybie DirectQuery. Używanie z źródłami danych, które obsługują logowanie jednokrotne. Zazwyczaj należy użyć tej flagi lub `useCallerAADIdentity`.

credentialType

Typ poświadczeń źródła danych

Nazwa	Typ	Opis
Anonymous	string
Basic	string
Key	string
OAuth2	string
SAS	string
Windows	string

encryptedConnection

Czy szyfrować połączenie ze źródłem danych. Wywołanie interfejsu API zakończy się niepowodzeniem, jeśli wybierzesz szyfrowanie, a usługa Power BI nie może nawiązać zaszyfrowanego połączenia ze źródłem danych.

Nazwa	Typ	Opis
Encrypted	string
NotEncrypted	string

encryptionAlgorithm

Algorytm szyfrowania. W przypadku źródła danych w chmurze określ wartość None. W przypadku lokalnego źródła danych określ RSA-OAEP klucz publiczny bramy i użyj go do zaszyfrowania poświadczeń.

Nazwa	Typ	Opis
None	string
RSA-OAEP	string

privacyLevel

Poziom prywatności, który jest istotny podczas łączenia danych z wielu źródeł.

Nazwa	Typ	Opis
None	string
Organizational	string
Private	string
Public	string

UpdateDatasourceRequest

Żądanie aktualizacji źródła danych do bramy

Nazwa	Typ	Opis
credentialDetails	CredentialDetails	Szczegóły poświadczeń

Udostępnij za pośrednictwem

Gateways - Update Datasource

Uprawnienia

Zakres wymagany

Ograniczenia

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Przykłady

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

Definicje

CredentialDetails

credentialType

encryptedConnection

encryptionAlgorithm

privacyLevel

UpdateDatasourceRequest

Dodatkowe zasoby