Gateways - Update Datasource

Referencia

Service:: Power BI REST APIs

API Version:: v1.0

Novedades las credenciales del origen de datos especificado de la puerta de enlace especificada.

Las credenciales del origen de datos local se deben cifrar, como se describe en el ejemplo de credenciales cifradas locales.

Nota

Para cifrar las credenciales, consulte Configuración de credenciales mediante programación para Power BI y revise los ejemplos de EncryptCredentials .NET Core, Java y Python .
Las credenciales de Windows antes del cifrado son similares a las credenciales del ejemplo de credenciales básicas.

Al cambiar de inicio de sesión único a otros tipos de credenciales, como Basic o OAuth2, establezca el parámetro falseuseEndUserOAuth2Credentials en como se describe en el ejemplo de credenciales básicas.

Las credenciales de OAuth 2.0 son válidas siempre que el token proporcionado sea válido. Al usar el tipo de credencial OAuth 2.0, haga lo siguiente:

Establezca correctamente la audiencia del token de OAuth 2.0, según el tipo de origen de datos.
Envíe el token de OAuth 2.0 en la carga, como se muestra en el ejemplo de credenciales de OAuth 2.0.
Si usa orígenes de datos de extensión , no establezca en useCallerAADIdentitytrue.

Permisos

Con las puertas de enlace locales, el usuario debe tener permisos de administrador de puerta de enlace.
Con los orígenes de datos en la nube, el usuario debe ser el propietario del origen de datos. Uso de datasets- Take Over API para transferir la propiedad sobre el conjunto de datos especificado o los informes paginados: Take Over API para transferir la propiedad de los orígenes de datos a través del informe paginado especificado.
Un perfil de entidad de servicio puede llamar a esta llamada API. Para obtener más información, consulte: Perfiles de entidad de servicio en Power BI Embedded.

Ámbito requerido

Dataset.ReadWrite.All

Limitaciones

Al establecer las credenciales de OAuth, no se incorpora un token de actualización, ya que es al establecer las credenciales a través de la interfaz de usuario en servicio Power BI. Por lo tanto, las credenciales solo se pueden usar durante una hora.
No se admiten puertas de enlace de red virtual (VNet).
Las credenciales de token de SAS solo se admiten con AzureBlobStorage y AzureDataLakeStorage.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
datasourceId	path	True	string uuid	Identificador del origen de datos
gatewayId	path	True	string uuid	Identificador de puerta de enlace. Cuando se usa un clúster de puerta de enlace, el identificador de puerta de enlace hace referencia a la puerta de enlace principal (primera) del clúster. En tales casos, el identificador de puerta de enlace es similar al identificador del clúster de puerta de enlace.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
credentialDetails	True	CredentialDetails	Detalles de las credenciales

Respuestas

Nombre	Tipo	Description
200 OK		Aceptar

Ejemplos

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

Definiciones

Nombre	Description
CredentialDetails	Detalles de las credenciales
credentialType	El tipo de credencial del origen de datos
encryptedConnection	Si se va a cifrar la conexión del origen de datos. Se producirá un error en la llamada API si selecciona cifrado y Power BI no puede establecer una conexión cifrada con el origen de datos.
encryptionAlgorithm	Algoritmo de cifrado. Para un origen de datos en la nube, especifique `None`. Para un origen de datos local, especifique `RSA-OAEP` y use la clave pública de puerta de enlace para cifrar las credenciales.
privacyLevel	Nivel de privacidad, que es relevante al combinar datos de varios orígenes.
UpdateDatasourceRequest	Un origen de datos de actualización a una solicitud de puerta de enlace

CredentialDetails

Detalles de las credenciales

Nombre	Tipo	Description
credentialType	credentialType	Tipo de credencial
credentials	string	Las credenciales, que dependen del valor "credentialType". Para obtener más información, consulte Actualización de ejemplos de orígenes de datos .
encryptedConnection	encryptedConnection	Si se va a cifrar la conexión del origen de datos. Se producirá un error en la llamada API si selecciona cifrado y Power BI no puede establecer una conexión cifrada con el origen de datos.
encryptionAlgorithm	encryptionAlgorithm	Algoritmo de cifrado. Para un origen de datos en la nube, especifique `None`. Para un origen de datos local, especifique `RSA-OAEP` y use la clave pública de puerta de enlace para cifrar las credenciales.
privacyLevel	privacyLevel	Nivel de privacidad, que es relevante al combinar datos de varios orígenes.
useCallerAADIdentity	boolean	Si la identidad de Azure AD (credenciales de OAuth 2.0) del autor de la llamada de API (que debe ser el propietario del origen de datos) se usará para configurar las credenciales del origen de datos (el token de acceso de OAuth propietario). Normalmente, usaría esta marca o `useEndUserOAuth2Credentials`.
useEndUserOAuth2Credentials	boolean	Si se usa la identidad de Azure AD de usuario final (credenciales de OAuth 2.0) al conectarse al origen de datos en modo DirectQuery. Use con orígenes de datos que admitan el inicio de sesión único (SSO). Normalmente, usaría esta marca o `useCallerAADIdentity`.

credentialType

El tipo de credencial del origen de datos

Nombre	Tipo	Description
Anonymous	string
Basic	string
Key	string
OAuth2	string
SAS	string
Windows	string

encryptedConnection

Si se va a cifrar la conexión del origen de datos. Se producirá un error en la llamada API si selecciona cifrado y Power BI no puede establecer una conexión cifrada con el origen de datos.

Nombre	Tipo	Description
Encrypted	string
NotEncrypted	string

encryptionAlgorithm

Algoritmo de cifrado. Para un origen de datos en la nube, especifique None. Para un origen de datos local, especifique RSA-OAEP y use la clave pública de puerta de enlace para cifrar las credenciales.

Nombre	Tipo	Description
None	string
RSA-OAEP	string

privacyLevel

Nivel de privacidad, que es relevante al combinar datos de varios orígenes.

Nombre	Tipo	Description
None	string
Organizational	string
Private	string
Public	string

UpdateDatasourceRequest

Un origen de datos de actualización a una solicitud de puerta de enlace

Nombre	Tipo	Description
credentialDetails	CredentialDetails	Detalles de las credenciales

Compartir a través de

Gateways - Update Datasource

Permisos

Ámbito requerido

Limitaciones

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Ejemplos

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

Definiciones

CredentialDetails

credentialType

encryptedConnection

encryptionAlgorithm

privacyLevel

UpdateDatasourceRequest

Recursos adicionales