Gateways - Update Datasource

Riferimento

Service:: Power BI REST APIs

API Version:: v1.0

Aggiornamenti le credenziali dell'origine dati specificata dal gateway specificato.

Le credenziali dell'origine dati locale devono essere crittografate, come descritto nell'esempio di credenziali crittografate locali.

Nota

Per crittografare le credenziali, vedere Configurare le credenziali a livello di codice per Power BI ed esaminare gli esempi di EncryptCredentials .NET Core, Java e Python .
Le credenziali di Windows prima della crittografia sono simili alle credenziali nell'esempio delle credenziali di base.

Quando si passa dall'accesso Single Sign-On ad altri tipi di credenziali, ad esempio Basic o OAuth2, impostare il parametro useEndUserOAuth2Credentials su false come descritto nell'esempio di credenziali di base.

Le credenziali OAuth 2.0 sono valide purché il token specificato sia valido. Quando si usa il tipo di credenziale OAuth 2.0, eseguire le operazioni seguenti:

Impostare correttamente il gruppo di destinatari del token OAuth 2.0 in base al tipo di origine dati.
Inviare il token OAuth 2.0 nel payload, come illustrato nell'esempio di credenziali OAuth 2.0.
Se si usano origini dati di estensione , non impostare su useCallerAADIdentitytrue.

Autorizzazioni

Con i gateway locali, l'utente deve disporre delle autorizzazioni di amministratore del gateway.
Con le origini dati cloud, l'utente deve essere il proprietario dell'origine dati. Usare l'API Set di dati - Take Over per trasferire la proprietà sul set di dati specificato o sui report impaginati- API Take Over per trasferire la proprietà delle origini dati nel report impaginato specificato.
Questa chiamata API può essere chiamata da un profilo entità servizio. Per altre informazioni, vedere Profili entità servizio in Power BI Embedded.

Ambito obbligatorio

Dataset.ReadWrite.All

Limitazioni

Quando si impostano le credenziali OAuth, un token di aggiornamento non viene incorporato così come quando si impostano le credenziali tramite l'interfaccia utente in servizio Power BI. Pertanto, le credenziali possono essere usate solo per un'ora.
I gateway di rete virtuale (VNet) non sono supportati.
Le credenziali del token di firma di accesso condiviso sono supportate solo con AzureBlobStorage e AzureDataLakeStorage.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
datasourceId	path	True	string uuid	ID origine dati
gatewayId	path	True	string uuid	ID gateway. Quando si usa un cluster gateway, l'ID gateway fa riferimento al gateway primario (primo) nel cluster. In questi casi, l'ID gateway è simile all'ID cluster del gateway.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
credentialDetails	True	CredentialDetails	Dettagli delle credenziali

Risposte

Nome	Tipo	Descrizione
200 OK		OK

Esempio

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

Definizioni

Nome	Descrizione
CredentialDetails	Dettagli delle credenziali
credentialType	Tipo di credenziale dell'origine dati
encryptedConnection	Indica se crittografare la connessione all'origine dati. La chiamata API avrà esito negativo se si seleziona la crittografia e Power BI non riesce a stabilire una connessione crittografata con l'origine dati.
encryptionAlgorithm	Algoritmo di crittografia. Per un'origine dati cloud, specificare `None`. Per un'origine dati locale, specificare `RSA-OAEP` e usare la chiave pubblica del gateway per crittografare le credenziali.
privacyLevel	Livello di privacy, che è rilevante quando si combinano dati da più origini.
UpdateDatasourceRequest	Richiesta di aggiornamento dell'origine dati al gateway

CredentialDetails

Dettagli delle credenziali

Nome	Tipo	Descrizione
credentialType	credentialType	Tipo di credenziale
credentials	string	Le credenziali, che dipendono dal valore "credentialType". Per altre informazioni, vedere Aggiornare esempi di origini dati .
encryptedConnection	encryptedConnection	Indica se crittografare la connessione all'origine dati. La chiamata API avrà esito negativo se si seleziona la crittografia e Power BI non riesce a stabilire una connessione crittografata con l'origine dati.
encryptionAlgorithm	encryptionAlgorithm	Algoritmo di crittografia. Per un'origine dati cloud, specificare `None`. Per un'origine dati locale, specificare `RSA-OAEP` e usare la chiave pubblica del gateway per crittografare le credenziali.
privacyLevel	privacyLevel	Livello di privacy, che è rilevante quando si combinano dati da più origini.
useCallerAADIdentity	boolean	Se l'identità di Azure AD (credenziali OAuth 2.0) del chiamante API (che deve essere il proprietario dell'origine dati) verrà usata per configurare le credenziali dell'origine dati (il token di accesso OAuth proprietario). In genere, si userebbe questo flag o `useEndUserOAuth2Credentials`.
useEndUserOAuth2Credentials	boolean	Indica se l'identità di Azure AD dell'utente finale (credenziali OAuth 2.0) viene usata durante la connessione all'origine dati in modalità DirectQuery. Usare con le origini dati che supportano l'accesso Single Sign-On (SSO). In genere, si userebbe questo flag o `useCallerAADIdentity`.

credentialType

Tipo di credenziale dell'origine dati

Nome	Tipo	Descrizione
Anonymous	string
Basic	string
Key	string
OAuth2	string
SAS	string
Windows	string

encryptedConnection

Indica se crittografare la connessione all'origine dati. La chiamata API avrà esito negativo se si seleziona la crittografia e Power BI non riesce a stabilire una connessione crittografata con l'origine dati.

Nome	Tipo	Descrizione
Encrypted	string
NotEncrypted	string

encryptionAlgorithm

Algoritmo di crittografia. Per un'origine dati cloud, specificare None. Per un'origine dati locale, specificare RSA-OAEP e usare la chiave pubblica del gateway per crittografare le credenziali.

Nome	Tipo	Descrizione
None	string
RSA-OAEP	string

privacyLevel

Livello di privacy, che è rilevante quando si combinano dati da più origini.

Nome	Tipo	Descrizione
None	string
Organizational	string
Private	string
Public	string

UpdateDatasourceRequest

Richiesta di aggiornamento dell'origine dati al gateway

Nome	Tipo	Descrizione
credentialDetails	CredentialDetails	Dettagli delle credenziali

Share via

Gateways - Update Datasource

Autorizzazioni

Ambito obbligatorio

Limitazioni

Parametri dell'URI

Corpo della richiesta

Risposte

Esempio

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

Definizioni

CredentialDetails

credentialType

encryptedConnection

encryptionAlgorithm

privacyLevel

UpdateDatasourceRequest

Risorse aggiuntive