Gateways - Create Datasource

Layanan:

Power BI REST APIs

Versi API:

v1.0

Membuat sumber data baru di gateway lokal yang ditentukan.

Kredensial sumber data lokal harus dienkripsi. Parameter encryptedConnection harus diatur ke Encrypted dan kredensial harus dienkripsi menggunakan kunci publik gateway.

Lihat Membuat Gateway DataSource skrip PowerShell untuk contoh penggunaan API ini, skrip ini menggunakan skrip PowerShell yang disebutkan dalam catatan di bawah ini untuk mengenkripsi kredensial.

Nota

Untuk mengenkripsi kredensial, lihat Mengonfigurasi kredensial secara terprogram untuk Power BI dan meninjau .NET Core , Java, Python dan contoh PowerShell.

Hak akses

Hanya mendukung gateway lokal dan pengguna harus memiliki izin admin gateway

Cakupan yang Diperlukan

Himpunan Data.ReadWrite.All

Keterbatasan

• Gateway jaringan virtual (VNet) dan Cloud tidak didukung.
• OAuth2 sebagai jenis kredensial tidak didukung.
  
  

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
gatewayId	path	True	string (uuid)	ID gateway. Saat menggunakan kluster gateway, ID gateway mengacu pada gateway utama (pertama) di kluster. Dalam kasus seperti itu, ID gateway mirip dengan ID kluster gateway.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
connectionDetails	True	string	Detail koneksi
credentialDetails	True	CredentialDetails	Detail kredensial
dataSourceName	True	string	Nama sumber data
dataSourceType	True	string	Jenis sumber data

Respons

Nama	Jenis	Deskripsi
201 Created	GatewayDatasource	Dibuat

Contoh

Azure Analysis Services example

SQL example

Azure Analysis Services example

Permintaan sampel

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

Isi Permintaan

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

Respon sampel

Kode status:

200

SQL example

Permintaan sampel

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

Isi Permintaan

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

Respon sampel

Kode status:

200

Definisi

Nama	Deskripsi
CredentialDetails	Detail kredensial
credentialType	Jenis sumber data kredensial
encryptedConnection	Apakah akan mengenkripsi koneksi sumber data. Panggilan API akan gagal jika Anda memilih enkripsi dan Power BI tidak dapat membuat koneksi terenkripsi dengan sumber data.
encryptionAlgorithm	Algoritma enkripsi. Untuk sumber data cloud, tentukan None. Untuk sumber data lokal, tentukan RSA-OAEP dan gunakan kunci publik gateway untuk mengenkripsi kredensial.
GatewayDatasource	Sumber data gateway Power BI
GatewayDatasourceCredentialDetails	Detail kredensial sumber data
privacyLevel	Tingkat privasi, yang relevan saat menggabungkan data dari beberapa sumber.
PublishDatasourceToGatewayRequest	Permintaan terbitkan sumber data ke gateway

CredentialDetails

Objek

Detail kredensial

Nama	Jenis	Deskripsi
credentialType	credentialType	Jenis kredensial
credentials	string	Kredensial, yang bergantung pada nilai 'credentialType'. Untuk informasi selengkapnya, lihat Memperbarui contoh Sumber Data.
encryptedConnection	encryptedConnection	Apakah akan mengenkripsi koneksi sumber data. Panggilan API akan gagal jika Anda memilih enkripsi dan Power BI tidak dapat membuat koneksi terenkripsi dengan sumber data.
encryptionAlgorithm	encryptionAlgorithm	Algoritma enkripsi. Untuk sumber data cloud, tentukan None. Untuk sumber data lokal, tentukan RSA-OAEP dan gunakan kunci publik gateway untuk mengenkripsi kredensial.
privacyLevel	privacyLevel	Tingkat privasi, yang relevan saat menggabungkan data dari beberapa sumber.
useCallerAADIdentity	boolean	Apakah identitas Azure AD (kredensial OAuth 2.0) pemanggil API (yang harus menjadi pemilik sumber data) akan digunakan untuk mengonfigurasi kredensial sumber data (token akses OAuth pemilik). Biasanya, Anda akan menggunakan bendera ini atau useEndUserOAuth2Credentials.
useEndUserOAuth2Credentials	boolean	Apakah identitas Azure AD pengguna akhir (kredensial OAuth 2.0) digunakan saat menyambungkan ke sumber data dalam mode DirectQuery. Gunakan dengan sumber data yang mendukung akses menyeluruh (SSO) . Biasanya, Anda akan menggunakan bendera ini atau useCallerAADIdentity.

credentialType

Enumerasi

Jenis sumber data kredensial

Nilai	Deskripsi
Basic
Windows
Anonymous
OAuth2
Key
SAS
KeyPair

encryptedConnection

Enumerasi

Apakah akan mengenkripsi koneksi sumber data. Panggilan API akan gagal jika Anda memilih enkripsi dan Power BI tidak dapat membuat koneksi terenkripsi dengan sumber data.

Nilai	Deskripsi
Encrypted
NotEncrypted

encryptionAlgorithm

Enumerasi

Algoritma enkripsi. Untuk sumber data cloud, tentukan None. Untuk sumber data lokal, tentukan RSA-OAEP dan gunakan kunci publik gateway untuk mengenkripsi kredensial.

Nilai	Deskripsi
None
RSA-OAEP

GatewayDatasource

Objek

Sumber data gateway Power BI

Nama	Jenis	Deskripsi
connectionDetails	string	Detail koneksi dalam format JSON
credentialDetails	GatewayDatasourceCredentialDetails	Detail koneksi untuk sumber data yang perlu diperbarui. Detail koneksi wajib ketika himpunan data memiliki lebih dari satu sumber data.
credentialType	credentialType	Jenis sumber data kredensial
datasourceName	string	Nama sumber data
datasourceType	string	Jenis sumber data . Nama API untuk sumber data ActiveDirectory AdobeAnalytics AdoDotNet AnalysisServices AzureBlobs AzureDataLakeStorage AzureMarketplace AzureTables BizTalk CDPA CustomConnector KustomHttpApi DB2 Essbase EventHub Excel Pertukaran Ekstensi Facebook Arsip Folder 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 Web
gatewayId	string (uuid)	ID gateway terkait. Saat menggunakan kluster gateway, ID gateway mengacu pada gateway utama (pertama) di kluster dan mirip dengan ID kluster gateway.
id	string (uuid)	ID unik untuk sumber data

GatewayDatasourceCredentialDetails

Objek

Detail kredensial sumber data

Nama	Jenis	Deskripsi
useEndUserOAuth2Credentials	boolean	Apakah identitas Azure AD pengguna akhir (kredensial OAuth 2.0) digunakan saat menyambungkan ke sumber data dalam mode DirectQuery. Gunakan dengan sumber data yang mendukung akses menyeluruh (SSO) .

privacyLevel

Enumerasi

Tingkat privasi, yang relevan saat menggabungkan data dari beberapa sumber.

Nilai	Deskripsi
None
Public
Organizational
Private

PublishDatasourceToGatewayRequest

Objek

Permintaan terbitkan sumber data ke gateway

Nama	Jenis	Deskripsi
connectionDetails	string	Detail koneksi
credentialDetails	CredentialDetails	Detail kredensial
dataSourceName	string	Nama sumber data
dataSourceType	string	Jenis sumber data