Gateways - Update Datasource

Atualizações as credenciais da fonte de dados especificada do gateway especificado.

As credenciais da fonte de dados local devem ser criptografadas, conforme descrito no exemplo de credenciais criptografadas locais.

Ao alterar de logon único para outros tipos de credencial, como Basic ou OAuth2, defina o parâmetro useEndUserOAuth2Credentialsfalse como conforme descrito no exemplo de credenciais básicas.

As credenciais do OAuth 2.0 são válidas desde que o token fornecido seja válido. Ao usar o tipo de credencial OAuth 2.0, faça o seguinte:

• Defina o público-alvo do token OAuth 2.0 corretamente, de acordo com o tipo de fonte de dados.
• Envie o token OAuth 2.0 no conteúdo, conforme mostrado no exemplo de credenciais do OAuth 2.0.
• Se você estiver usando fontes de dados de extensão , não defina useCallerAADIdentitytruecomo .

Permissões

• Com gateways locais, o usuário deve ter permissões de administrador de gateway.
• Com fontes de dados de nuvem, o usuário deve ser o proprietário da fonte de dados. Usar conjuntos de dados – Assumir a API para transferir a propriedade sobre o conjunto de dados especificado ou relatórios paginados – Assumir a API para transferir a propriedade das fontes de dados pelo relatório paginado especificado.
• Essa chamada à API pode ser chamada por um perfil de entidade de serviço. Para obter mais informações, consulte: Perfis de entidade de serviço no Power BI Embedded.

Escopo necessário

Dataset.ReadWrite.All

Limitações

• Ao definir as credenciais do OAuth, um token de atualização não é incorporado como é ao definir credenciais por meio da interface do usuário em serviço do Power BI. Portanto, as credenciais só podem ser usadas por uma hora.
• Não há suporte para gateways de VNet (rede virtual).
• As credenciais do Token SAS têm suporte apenas com AzureBlobStorage e AzureDataLakeStorage.
  
  

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

Parâmetros de URI

Corpo da solicitação

Respostas

Exemplos

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

Definições

CredentialDetails

Os detalhes da credencial

credentialType

O tipo de credencial da fonte de dados

encryptedConnection

Se a conexão da fonte de dados deve ser criptografada. A chamada à API falhará se você selecionar criptografia e o Power BI não conseguir estabelecer uma conexão criptografada com a fonte de dados.

encryptionAlgorithm

O algoritmo de criptografia. Para uma fonte de dados de nuvem, especifique None. Para uma fonte de dados local, especifique RSA-OAEP e use a chave pública do gateway para criptografar as credenciais.

privacyLevel

O nível de privacidade, que é relevante ao combinar dados de várias fontes.

UpdateDatasourceRequest

Uma fonte de dados de atualização para a solicitação de gateway