Gateways - Update Datasource

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

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

Consulte el script de PowerShell patch Datasource Credentials para obtener un ejemplo de uso de esta API. Este script usa el script de PowerShell mencionado en la nota siguiente para cifrar las credenciales.

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 de OAuth 2.0, haga lo siguiente:

• Establezca correctamente el público de tokens 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.

Permissions

• 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 conjuntos de datos: Api de take over para transferir la propiedad sobre el conjunto de datos especificado o los informes paginados: tómese la 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 cuando se establecen las credenciales a través de la interfaz de usuario en el 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

Cuerpo de la solicitud

Respuestas

Ejemplos

Anonymous credentials example

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

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

Basic credentials example

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

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

Key credentials example

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

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

OAuth 2.0 credentials example

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

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

On-premise encrypted credentials example

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

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

SAS Token credentials example

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

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

Definiciones

CredentialDetails

Detalles de las credenciales

credentialType

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 la solicitud de puerta de enlace