Gateways - Update Datasource

Ссылка

Service:: Power BI REST APIs

API Version:: v1.0

Обновления учетные данные указанного источника данных из указанного шлюза.

Учетные данные локального источника данных должны быть зашифрованы, как описано в примере локальных зашифрованных учетных данных.

Примечание

Сведения о шифровании учетных данных см. в статье Настройка учетных данных программным способом для Power BI и примеры EncryptCredentials .NET Core, Java и Python .
Учетные данные Windows перед шифрованием выглядят как учетные данные в примере учетных данных Basic.

При переходе с единого входа на другие типы учетных данных, например Basic или OAuth2, задайте для параметра useEndUserOAuth2Credentials значение false , как описано в примере базовых учетных данных.

Учетные данные OAuth 2.0 действительны при условии, что предоставленный маркер действителен. При использовании типа учетных данных OAuth 2.0 выполните следующие действия.

Правильно задайте аудиторию маркеров OAuth 2.0 в соответствии с типом источника данных.
Отправьте маркер OAuth 2.0 в полезные данные, как показано в примере учетных данных OAuth 2.0.
Если вы используете источники данных расширения , не устанавливайте значение useCallerAADIdentitytrue.

Разрешения

При использовании локальных шлюзов пользователь должен иметь разрешения администратора шлюза.
При использовании облачных источников данных пользователь должен быть владельцем источника данных. Используйте API наборов данных для передачи прав собственности на указанный набор данных или отчеты с разбивкой на страницы. Api Take Over для передачи прав владения источниками данных через указанный отчет с разбивкой на страницы.
Этот вызов API может вызываться профилем субъекта-службы. Дополнительные сведения см. в статье Профили субъектов-служб в Power BI Embedded.

Требуемая область

Dataset.ReadWrite.All

Ограничения

При настройке учетных данных OAuth маркер обновления не включается, как при настройке учетных данных через пользовательский интерфейс в служба Power BI. Таким образом, учетные данные можно использовать только в течение одного часа.
Шлюзы виртуальной сети не поддерживаются.
Учетные данные маркера SAS поддерживаются только в AzureBlobStorage и AzureDataLakeStorage.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
datasourceId	path	True	string uuid	Идентификатор источника данных
gatewayId	path	True	string uuid	Идентификатор шлюза. При использовании кластера шлюза идентификатор шлюза относится к основному (первому) шлюзу в кластере. В таких случаях идентификатор шлюза аналогичен идентификатору кластера шлюза.

Текст запроса

Имя	Обязательно	Тип	Описание
credentialDetails	True	CredentialDetails	Сведения об учетных данных

Ответы

Имя	Тип	Описание
200 OK		ОК

Примеры

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

Определения

Имя	Описание
CredentialDetails	Сведения об учетных данных
credentialType	Тип учетных данных источника данных
encryptedConnection	Указывает, следует ли шифровать подключение к источнику данных. Вызов API завершится ошибкой, если выбрано шифрование и Power BI не сможет установить зашифрованное подключение к источнику данных.
encryptionAlgorithm	Алгоритм шифрования. Для облачного источника данных укажите `None`. Для локального источника данных укажите `RSA-OAEP` и используйте открытый ключ шлюза для шифрования учетных данных.
privacyLevel	Уровень конфиденциальности, который имеет значение при объединении данных из нескольких источников.
UpdateDatasourceRequest	Обновление источника данных для запроса шлюза

CredentialDetails

Сведения об учетных данных

Имя	Тип	Описание
credentialType	credentialType	Тип учетных данных
credentials	string	Учетные данные, которые зависят от значения credentialType. Дополнительные сведения см. в разделе Примеры обновления источников данных .
encryptedConnection	encryptedConnection	Указывает, следует ли шифровать подключение к источнику данных. Вызов API завершится ошибкой, если выбрано шифрование и Power BI не сможет установить зашифрованное подключение к источнику данных.
encryptionAlgorithm	encryptionAlgorithm	Алгоритм шифрования. Для облачного источника данных укажите `None`. Для локального источника данных укажите `RSA-OAEP` и используйте открытый ключ шлюза для шифрования учетных данных.
privacyLevel	privacyLevel	Уровень конфиденциальности, который имеет значение при объединении данных из нескольких источников.
useCallerAADIdentity	boolean	Указывает, будет ли использоваться удостоверение Azure AD (учетные данные OAuth 2.0) вызывающего API (который должен быть владельцем источника данных) для настройки учетных данных источника данных (маркера доступа владельца OAuth). Как правило, вы используете этот флаг или `useEndUserOAuth2Credentials`.
useEndUserOAuth2Credentials	boolean	Используется ли удостоверение Azure AD конечного пользователя (учетные данные OAuth 2.0) при подключении к источнику данных в режиме DirectQuery. Используйте с источниками данных, поддерживающими единый вход. Как правило, вы используете этот флаг или `useCallerAADIdentity`.

credentialType

Тип учетных данных источника данных

Имя	Тип	Описание
Anonymous	string
Basic	string
Key	string
OAuth2	string
SAS	string
Windows	string

encryptedConnection

Указывает, следует ли шифровать подключение к источнику данных. Вызов API завершится ошибкой, если выбрано шифрование и Power BI не сможет установить зашифрованное подключение к источнику данных.

Имя	Тип	Описание
Encrypted	string
NotEncrypted	string

encryptionAlgorithm

Алгоритм шифрования. Для облачного источника данных укажите None. Для локального источника данных укажите RSA-OAEP и используйте открытый ключ шлюза для шифрования учетных данных.

Имя	Тип	Описание
None	string
RSA-OAEP	string

privacyLevel

Уровень конфиденциальности, который имеет значение при объединении данных из нескольких источников.

Имя	Тип	Описание
None	string
Organizational	string
Private	string
Public	string

UpdateDatasourceRequest

Обновление источника данных для запроса шлюза

Имя	Тип	Описание
credentialDetails	CredentialDetails	Сведения об учетных данных

Gateways - Update Datasource

Разрешения

Требуемая область

Ограничения

Параметры URI

Текст запроса

Ответы

Примеры

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

Определения

CredentialDetails

credentialType

encryptedConnection

encryptionAlgorithm

privacyLevel

UpdateDatasourceRequest

Дополнительные ресурсы