Gateways - Create Datasource

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

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

Создает новый источник данных в указанном локальном шлюзе.

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

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

Замечание

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

Permissions

Поддерживает только локальные шлюзы, а у пользователя должны быть разрешения администратора шлюза.

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

Dataset.ReadWrite.All

Ограничения

Виртуальные сети (виртуальная сеть) и облачные шлюзы не поддерживаются.
OAuth2 в качестве типа учетных данных не поддерживается.

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

Параметры URI

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

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

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

Ответы

Имя	Тип	Описание
201 Created	GatewayDatasource	Создано

Примеры

Azure Analysis Services example

SQL example

Azure Analysis Services example

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

POST https://api.powerbi.com/v1.0/myorg/gateways/1f69e798-5852-4fdd-ab01-33bb14b6e934/datasources

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

{
  "dataSourceType": "AnalysisServices",
  "connectionDetails": "{\"server\":\"MyServer\",\"database\":\"MyDatabase\"}",
  "datasourceName": "Sample Datasource",
  "credentialDetails": {
    "credentialType": "Windows",
    "credentials": "AB....EF==",
    "encryptedConnection": "Encrypted",
    "encryptionAlgorithm": "RSA-OAEP",
    "privacyLevel": "None"
  }
}

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

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

SQL example

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

POST https://api.powerbi.com/v1.0/myorg/gateways/1f69e798-5852-4fdd-ab01-33bb14b6e934/datasources

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

{
  "dataSourceType": "SQL",
  "connectionDetails": "{\"server\":\"MyServer\",\"database\":\"MyDatabase\"}",
  "datasourceName": "Sample Datasource",
  "credentialDetails": {
    "credentialType": "Windows",
    "credentials": "AB....EF==",
    "encryptedConnection": "Encrypted",
    "encryptionAlgorithm": "RSA-OAEP",
    "privacyLevel": "None"
  }
}

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

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

Определения

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

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

GatewayDatasource

Object

Источник данных шлюза Power BI

Имя

Тип

Описание

connectionDetails

string

Сведения о подключении в формате JSON

credentialDetails

GatewayDatasourceCredentialDetails

Сведения о подключении для источника данных, требующего обновления. Сведения о подключении обязательны, если набор данных имеет несколько источников данных.

credentialType

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

datasourceName

string

Имя источника данных

datasourceType

string

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

Имя API для источника данных
ActiveDirectory	AdobeAnalytics	AdoDotNet
AnalysisServices	Большие двоичные объекты Azure	AzureDataLakeStorage
AzureMarketplace	AzureTables	BizTalk
CDPA	CustomConnector	CustomHttpApi
DB2	Essbase	EventHub
Excel	Обмен	Extension
Facebook	Файл	Папка
GoogleAnalytics	Hdfs	HDInsight
Informix	MQ	MySql
OData	ODBC (Интерфейс открытой базы данных)	OleDb
Oracle;	PostgreSql	PowerQueryMashup
PubNub	Salesforce	SAPBW
SAPBWMessageServer	SapErp	SAPHana
SharePoint	SharePointDocLib	SharePointList
Sql	Sybase	Teradata
UIFlow	Интернет

gatewayId

string (uuid)

Идентификатор связанного шлюза. При использовании кластера шлюза идентификатор шлюза ссылается на первичный (первый) шлюз в кластере и аналогичен идентификатору кластера шлюза.

string (uuid)

Уникальный идентификатор источника данных

GatewayDatasourceCredentialDetails

Object

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

Имя	Тип	Описание
useEndUserOAuth2Credentials	boolean	Используется ли удостоверение Azure AD конечного пользователя (учетные данные OAuth 2.0) при подключении к источнику данных в режиме DirectQuery. Используйте источники данных, поддерживающие единый вход.

privacyLevel

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

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

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

PublishDatasourceToGatewayRequest

Object

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

Имя	Тип	Описание
connectionDetails	string	Сведения о подключении
credentialDetails	CredentialDetails	Сведения о учетных данных
dataSourceName	string	Имя источника данных
dataSourceType	string	Тип источника данных