Gateways - Update Datasource

Служба:: Power BI REST APIs

Версия API:: v1.0

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

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

Пример использования этого API см. в скрипте PowerShell с учетными данными источника исправлений , который используется в скрипте PowerShell, приведенном ниже, для шифрования учетных данных.

Замечание

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

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

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

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

Permissions

При использовании локальных шлюзов пользователь должен иметь разрешения администратора шлюза.
С облачными источниками данных пользователь должен быть владельцем источника данных. Используйте наборы данных . Переключение 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

Образец запроса

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

Пример ответа

Код состояния:: 200

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

Пример ответа

Код состояния:: 200

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

Пример ответа

Код состояния:: 200

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

Пример ответа

Код состояния:: 200

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

Пример ответа

Код состояния:: 200

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

Пример ответа

Код состояния:: 200

Определения

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

CredentialDetails

Object

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

Имя	Тип	Описание
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

Перечисление

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

Значение	Описание
Basic
Windows
Anonymous
OAuth2
Key
SAS

encryptedConnection

Перечисление

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

Значение	Описание
Encrypted
NotEncrypted

encryptionAlgorithm

Перечисление

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

Значение	Описание
None
RSA-OAEP

privacyLevel

Перечисление

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

Значение	Описание
None
Public
Organizational
Private

UpdateDatasourceRequest

Object

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

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

Поделиться через

Gateways - Update Datasource

Permissions

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

Ограничения

Параметры URI

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

Ответы

Примеры

Anonymous credentials example

Образец запроса

Пример ответа

Basic credentials example

Образец запроса

Пример ответа

Key credentials example

Образец запроса

Пример ответа

OAuth 2.0 credentials example

Образец запроса

Пример ответа

On-premise encrypted credentials example

Образец запроса

Пример ответа

SAS Token credentials example

Образец запроса

Пример ответа

Определения

CredentialDetails

credentialType

encryptedConnection

encryptionAlgorithm

privacyLevel

UpdateDatasourceRequest