Gateways - Update Datasource

Başvuru

Service:: Power BI REST APIs

API Version:: v1.0

Belirtilen ağ geçidinden belirtilen veri kaynağının kimlik bilgilerini Güncelleştirmeler.

Şirket içi şifrelenmiş kimlik bilgileri örneğinde açıklandığı gibi Şirket içi veri kaynağı kimlik bilgileri şifrelenmelidir.

Not

Kimlik bilgilerini şifrelemek için bkz. Power BI için kimlik bilgilerini program aracılığıyla yapılandırma ve EncryptCredentials .NET Core, Java ve Python örneklerini gözden geçirin.
Şifrelemeden önceki Windows kimlik bilgileri , Temel kimlik bilgileri örneğindeki kimlik bilgileri gibi görünür.

Çoklu oturum açmadan veya OAuth2gibi Basic diğer kimlik bilgileri türlerine geçiş yaparken, parametresini useEndUserOAuth2CredentialsfalseTemel kimlik bilgileri örneğinde açıklandığı gibi olarak ayarlayın.

Sağlanan belirteç geçerli olduğu sürece OAuth 2.0 kimlik bilgileri geçerlidir. OAuth 2.0 kimlik bilgisi türünü kullanırken aşağıdakileri yapın:

Veri kaynağı türüne göre OAuth 2.0 belirteci hedef kitlesini doğru ayarlayın.
OAuth 2.0 kimlik bilgileri örneğinde gösterildiği gibi yükte OAuth 2.0 belirtecini gönderin.
Uzantı veri kaynaklarını kullanıyorsanız olarak ayarlamayın useCallerAADIdentitytrue.

İzinler

Şirket içi ağ geçitlerinde, kullanıcının ağ geçidi yönetici izinlerine sahip olması gerekir.
Bulut veri kaynaklarıyla kullanıcının veri kaynağı sahibi olması gerekir. Belirtilen veri kümesi veya Sayfalandırılmış raporlar üzerindeki sahipliği aktarmak için Veri Kümeleri - Api'yi Devral özelliğini kullanma - Veri kaynaklarının sahipliğini belirtilen sayfalandırılmış rapor üzerinden aktarmak için API'yi devralın .
Bu API çağrısı bir hizmet sorumlusu profili tarafından çağrılabilir. Daha fazla bilgi için bkz. Power BI Embedded hizmet sorumlusu profilleri.

Gerekli Kapsam

Dataset.ReadWrite.All

Sınırlamalar

OAuth kimlik bilgilerini ayarlarken, Power BI hizmeti kullanıcı arabirimi aracılığıyla kimlik bilgilerini ayarlarken olduğu gibi yenileme belirteci dahil değildir. Bu nedenle kimlik bilgileri yalnızca bir saat kullanılabilir.
Sanal ağ (VNet) ağ geçitleri desteklenmez.
SAS Belirteci kimlik bilgileri yalnızca AzureBlobStorage ve AzureDataLakeStorage ile desteklenir.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
datasourceId	path	True	string uuid	Veri kaynağı kimliği
gatewayId	path	True	string uuid	Ağ geçidi kimliği. Ağ geçidi kümesi kullanılırken, ağ geçidi kimliği kümedeki birincil (ilk) ağ geçidine başvurur. Böyle durumlarda ağ geçidi kimliği, ağ geçidi küme kimliğine benzer.

İstek Gövdesi

Name	Gerekli	Tür	Description
credentialDetails	True	CredentialDetails	Kimlik bilgisi ayrıntıları

Yanıtlar

Name	Tür	Description
200 OK		Tamam

Örnekler

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

Tanımlar

Name	Description
CredentialDetails	Kimlik bilgisi ayrıntıları
credentialType	Veri kaynağı kimlik bilgilerinin türü
encryptedConnection	Veri kaynağı bağlantısının şifrelenip şifrelmeyeceği. Şifrelemeyi seçerseniz ve Power BI veri kaynağıyla şifreli bir bağlantı kuramazsa API çağrısı başarısız olur.
encryptionAlgorithm	Şifreleme algoritması. Bulut veri kaynağı için belirtin `None`. Şirket içi veri kaynağı için, kimlik bilgilerini şifrelemek için ağ geçidi ortak anahtarını belirtin `RSA-OAEP` ve kullanın.
privacyLevel	Birden çok kaynaktan gelen veriler birleştirildiğinde ilgili olan gizlilik düzeyi.
UpdateDatasourceRequest	Veri kaynağını ağ geçidi isteğine güncelleştirme

CredentialDetails

Kimlik bilgisi ayrıntıları

Name	Tür	Description
credentialType	credentialType	Kimlik bilgisi türü
credentials	string	'credentialType' değerine bağlı olan kimlik bilgileri. Daha fazla bilgi için bkz . Veri Kaynağını Güncelleştirme örnekleri.
encryptedConnection	encryptedConnection	Veri kaynağı bağlantısının şifrelenip şifrelmeyeceği. Şifrelemeyi seçerseniz ve Power BI veri kaynağıyla şifreli bir bağlantı kuramazsa API çağrısı başarısız olur.
encryptionAlgorithm	encryptionAlgorithm	Şifreleme algoritması. Bulut veri kaynağı için belirtin `None`. Şirket içi veri kaynağı için, kimlik bilgilerini şifrelemek için ağ geçidi ortak anahtarını belirtin `RSA-OAEP` ve kullanın.
privacyLevel	privacyLevel	Birden çok kaynaktan gelen veriler birleştirildiğinde ilgili olan gizlilik düzeyi.
useCallerAADIdentity	boolean	Veri kaynağı kimlik bilgilerini (sahip OAuth erişim belirteci) yapılandırmak için API çağıranın (veri kaynağı sahibi olması gerekir) Azure AD kimliğinin (OAuth 2.0 kimlik bilgileri) kullanılıp kullanılmayacağı. Genellikle bu bayrağı veya `useEndUserOAuth2Credentials`kullanırsınız.
useEndUserOAuth2Credentials	boolean	DirectQuery modunda veri kaynağına bağlanırken son kullanıcının Azure AD kimliğinin (OAuth 2.0 kimlik bilgileri) kullanılıp kullanılmadığı. Çoklu oturum açmayı (SSO) destekleyen veri kaynaklarıyla kullanın. Genellikle bu bayrağı veya `useCallerAADIdentity`kullanırsınız.

credentialType

Veri kaynağı kimlik bilgilerinin türü

Name	Tür	Description
Anonymous	string
Basic	string
Key	string
OAuth2	string
SAS	string
Windows	string

encryptedConnection

Veri kaynağı bağlantısının şifrelenip şifrelmeyeceği. Şifrelemeyi seçerseniz ve Power BI veri kaynağıyla şifreli bir bağlantı kuramazsa API çağrısı başarısız olur.

Name	Tür	Description
Encrypted	string
NotEncrypted	string

encryptionAlgorithm

Şifreleme algoritması. Bulut veri kaynağı için belirtin None. Şirket içi veri kaynağı için, kimlik bilgilerini şifrelemek için ağ geçidi ortak anahtarını belirtin RSA-OAEP ve kullanın.

Name	Tür	Description
None	string
RSA-OAEP	string

privacyLevel

Birden çok kaynaktan gelen veriler birleştirildiğinde ilgili olan gizlilik düzeyi.

Name	Tür	Description
None	string
Organizational	string
Private	string
Public	string

UpdateDatasourceRequest

Veri kaynağını ağ geçidi isteğine güncelleştirme

Name	Tür	Description
credentialDetails	CredentialDetails	Kimlik bilgisi ayrıntıları

Aracılığıyla paylaş

Gateways - Update Datasource

İzinler

Gerekli Kapsam

Sınırlamalar

URI Parametreleri

İstek Gövdesi

Yanıtlar

Örnekler

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

Tanımlar

CredentialDetails

credentialType

encryptedConnection

encryptionAlgorithm

privacyLevel

UpdateDatasourceRequest

Ek kaynaklar