다음을 통해 공유


Gateways - Update Datasource

지정된 게이트웨이에서 지정된 데이터 원본의 자격 증명을 업데이트.

온-프레미스 암호화 자격 증명 예제에 설명된 대로 온-프레미스 데이터 원본 자격 증명을 암호화해야 합니다.

참고

Single Sign-On에서 또는 OAuth2와 같은 다른 자격 증명 형식으로 Basic 변경하는 경우 기본 자격 증명 예제에 설명된 대로 매개 변수 useEndUserOAuth2Credentialsfalse 로 설정합니다.

OAuth 2.0 자격 증명은 제공된 토큰이 유효한 한 유효합니다. OAuth 2.0 자격 증명 형식을 사용하는 경우 다음을 수행합니다.

  • 데이터 원본 형식에 따라 OAuth 2.0 토큰 대상 그룹을 올바르게 설정합니다.
  • OAuth 2.0 자격 증명 예제와 같이 페이로드에 OAuth 2.0 토큰을 보냅니다.
  • 확장 데이터 원본을 사용하는 경우 로 설정 useCallerAADIdentitytrue하지 마세요.

사용 권한

필수 범위

Dataset.ReadWrite.All

제한 사항

  • OAuth 자격 증명을 설정할 때 새로 고침 토큰은 Power BI 서비스 UI를 통해 자격 증명을 설정할 때와 같이 통합되지 않습니다. 따라서 자격 증명은 1시간 동안만 사용할 수 있습니다.
  • VNet(가상 네트워크) 게이트웨이는 지원되지 않습니다.
  • SAS 토큰 자격 증명은 AzureBlobStorage 및 AzureDataLakeStorage에서만 지원됩니다.

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

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
datasourceId
path True

string

uuid

데이터 원본 ID

gatewayId
path True

string

uuid

게이트웨이 ID입니다. 게이트웨이 클러스터를 사용하는 경우 게이트웨이 ID는 클러스터의 기본(첫 번째) 게이트웨이를 참조합니다. 이러한 경우 게이트웨이 ID는 게이트웨이 클러스터 ID와 유사합니다.

요청 본문

Name 필수 형식 Description
credentialDetails True

CredentialDetails

자격 증명 세부 정보

응답

Name 형식 Description
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
{
  "credentialDetails": {
    "credentialType": "Anonymous",
    "credentials": "{\"credentialData\":\"\"}",
    "encryptedConnection": "Encrypted",
    "encryptionAlgorithm": "None",
    "privacyLevel": "None"
  }
}

Sample Response

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
{
  "credentialDetails": {
    "credentialType": "Basic",
    "credentials": "{\"credentialData\":[{\"name\":\"username\", \"value\":\"john\"},{\"name\":\"password\", \"value\":\"*****\"}]}",
    "encryptedConnection": "Encrypted",
    "encryptionAlgorithm": "None",
    "privacyLevel": "None",
    "useEndUserOAuth2Credentials": "False"
  }
}

Sample Response

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
{
  "credentialDetails": {
    "credentialType": "Key",
    "credentials": "{\"credentialData\":[{\"name\":\"key\", \"value\":\"ec....LA=\"}]}",
    "encryptedConnection": "Encrypted",
    "encryptionAlgorithm": "None",
    "privacyLevel": "None"
  }
}

Sample Response

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
{
  "credentialDetails": {
    "credentialType": "OAuth2",
    "credentials": "{\"credentialData\":[{\"name\":\"accessToken\", \"value\":\"eyJ0....fwtQ\"}]}",
    "encryptedConnection": "Encrypted",
    "encryptionAlgorithm": "None",
    "privacyLevel": "None"
  }
}

Sample Response

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
{
  "credentialDetails": {
    "credentialType": "Windows",
    "credentials": "AB....EF==",
    "encryptedConnection": "Encrypted",
    "encryptionAlgorithm": "RSA-OAEP",
    "privacyLevel": "None"
  }
}

Sample Response

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

정의

Name Description
CredentialDetails

자격 증명 세부 정보

credentialType

데이터 원본 자격 증명의 형식

encryptedConnection

데이터 원본 연결을 암호화할지 여부입니다. 암호화를 선택하고 Power BI가 데이터 원본과 암호화된 연결을 설정할 수 없는 경우 API 호출이 실패합니다.

encryptionAlgorithm

암호화 알고리즘입니다. 클라우드 데이터 원본의 경우 를 지정합니다 None. 온-프레미스 데이터 원본의 경우 게이트웨이 공개 키를 지정 RSA-OAEP 하고 사용하여 자격 증명을 암호화합니다.

privacyLevel

여러 원본의 데이터를 결합할 때 관련된 개인 정보 수준입니다.

UpdateDatasourceRequest

게이트웨이 요청에 대한 데이터 원본 업데이트

CredentialDetails

자격 증명 세부 정보

Name 형식 Description
credentialType

credentialType

자격 증명 형식

credentials

string

'credentialType' 값에 따라 달라지는 자격 증명입니다. 자세한 내용은 데이터 원본 예제 업데이트를 참조하세요.

encryptedConnection

encryptedConnection

데이터 원본 연결을 암호화할지 여부입니다. 암호화를 선택하고 Power BI가 데이터 원본과 암호화된 연결을 설정할 수 없는 경우 API 호출이 실패합니다.

encryptionAlgorithm

encryptionAlgorithm

암호화 알고리즘입니다. 클라우드 데이터 원본의 경우 를 지정합니다 None. 온-프레미스 데이터 원본의 경우 게이트웨이 공개 키를 지정 RSA-OAEP 하고 사용하여 자격 증명을 암호화합니다.

privacyLevel

privacyLevel

여러 원본의 데이터를 결합할 때 관련된 개인 정보 수준입니다.

useCallerAADIdentity

boolean

데이터 원본 소유자여야 하는 API 호출자의 Azure AD ID(OAuth 2.0 자격 증명)를 사용하여 데이터 원본 자격 증명(소유자 OAuth 액세스 토큰)을 구성할지 여부입니다. 일반적으로 이 플래그 또는 useEndUserOAuth2Credentials를 사용합니다.

useEndUserOAuth2Credentials

boolean

DirectQuery 모드에서 데이터 원본에 연결할 때 최종 사용자 Azure AD ID(OAuth 2.0 자격 증명)가 사용되는지 여부입니다. SSO(Single Sign-On)를 지원하는 데이터 원본과 함께 사용합니다. 일반적으로 이 플래그 또는 useCallerAADIdentity를 사용합니다.

credentialType

데이터 원본 자격 증명의 형식

Name 형식 Description
Anonymous

string

Basic

string

Key

string

OAuth2

string

SAS

string

Windows

string

encryptedConnection

데이터 원본 연결을 암호화할지 여부입니다. 암호화를 선택하고 Power BI가 데이터 원본과 암호화된 연결을 설정할 수 없는 경우 API 호출이 실패합니다.

Name 형식 Description
Encrypted

string

NotEncrypted

string

encryptionAlgorithm

암호화 알고리즘입니다. 클라우드 데이터 원본의 경우 를 지정합니다 None. 온-프레미스 데이터 원본의 경우 게이트웨이 공개 키를 지정 RSA-OAEP 하고 사용하여 자격 증명을 암호화합니다.

Name 형식 Description
None

string

RSA-OAEP

string

privacyLevel

여러 원본의 데이터를 결합할 때 관련된 개인 정보 수준입니다.

Name 형식 Description
None

string

Organizational

string

Private

string

Public

string

UpdateDatasourceRequest

게이트웨이 요청에 대한 데이터 원본 업데이트

Name 형식 Description
credentialDetails

CredentialDetails

자격 증명 세부 정보