Items - Get Connection String

서비스:

SQLEndpoint

API 버전:

v1

지정된 웨어하우스의 SQL 연결 문자열을 반환합니다.

Permissions

호출자에게 웨어하우스에 대한 읽기 권한이 있어야 합니다. 호출자에게 는 뷰어 이상의 작업 영역 역할이 있어야 합니다.

필요한 위임된 범위

SqlEndpoint.Read.All 또는 SqlEndpoint.ReadWrite.All 또는 Item.Read.All 또는 Item.ReadWrite.All

Microsoft Entra 지원 ID

이 API는 이 섹션에 나열된 Microsoft ID를 지원 합니다 .

아이덴티티	Support
사용자	Yes
서비스 주체 및 관리 ID	Yes

인터페이스

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sqlEndpoints/{sqlEndpointId}/connectionString

선택적 매개 변수:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sqlEndpoints/{sqlEndpointId}/connectionString?guestTenantId={guestTenantId}&privateLinkType={privateLinkType}

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
sqlEndpointId	path	True	string (uuid)	SQL 엔드포인트 ID입니다.
workspaceId	path	True	string (uuid)	작업 영역 ID입니다.
guestTenantId	query		string (uuid)	최종 사용자의 테넌트가 SQL 엔드포인트의 테넌트와 다른 경우 게스트 테넌트 ID입니다.
privateLinkType	query		PrivateLinkType	이 연결 문자열에서 사용하는 프라이빗 링크의 형식을 나타냅니다. 시간이 지남에 따라 추가 privateLinkType 형식을 추가할 수 있습니다.

응답

Name	형식	Description
200 OK	ConnectionStringResponse	요청이 성공적으로 완료되었습니다.
Other Status Codes	ErrorResponse	일반적인 오류 코드: ItemNotFound - 요청된 항목을 찾을 수 없습니다. InvalidGuestTenantId - 제공된 ID가 없습니다.

예제

Get connection string example

샘플 요청

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/sqlEndpoints/5b218778-e7a5-4d73-8187-f10824047715/connectionString?guestTenantId=6e335e92-a2a2-4b5a-970a-bd6a89fbb765&privateLinkType=Workspace

샘플 응답

상태 코드:

200

{
  "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m-jh0bi.zcf.datawarehouse.fabric.microsoft.com"
}

정의

Name	Description
ConnectionStringResponse	이 SQL 엔드포인트를 포함하는 작업 영역에 대한 SQL 연결 문자열입니다.
ErrorRelatedResource	오류 관련 리소스 세부 정보 개체입니다.
ErrorResponse	오류 응답입니다.
ErrorResponseDetails	오류 응답 세부 정보입니다.
PrivateLinkType	이 연결 문자열에서 사용하는 프라이빗 링크의 형식을 나타냅니다. 시간이 지남에 따라 추가 privateLinkType 형식을 추가할 수 있습니다.

ConnectionStringResponse

Object

이 SQL 엔드포인트를 포함하는 작업 영역에 대한 SQL 연결 문자열입니다.

Name	형식	Description
connectionString	string	이 SQL 엔드포인트를 포함하는 작업 영역에 대한 SQL 연결 문자열입니다.

ErrorRelatedResource

Object

오류 관련 리소스 세부 정보 개체입니다.

Name	형식	Description
resourceId	string	오류와 관련된 리소스 ID입니다.
resourceType	string	오류와 관련된 리소스의 형식입니다.

ErrorResponse

Object

오류 응답입니다.

Name	형식	Description
errorCode	string	오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.
message	string	사용자가 읽을 수 있는 오류 표현입니다.
moreDetails	ErrorResponseDetails[]	추가 오류 세부 정보 목록입니다.
relatedResource	ErrorRelatedResource	오류 관련 리소스 세부 정보입니다.
requestId	string	오류와 연결된 요청의 ID입니다.

ErrorResponseDetails

Object

오류 응답 세부 정보입니다.

Name	형식	Description
errorCode	string	오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.
message	string	사용자가 읽을 수 있는 오류 표현입니다.
relatedResource	ErrorRelatedResource	오류 관련 리소스 세부 정보입니다.

PrivateLinkType

열거형

이 연결 문자열에서 사용하는 프라이빗 링크의 형식을 나타냅니다. 시간이 지남에 따라 추가 privateLinkType 형식을 추가할 수 있습니다.

값	Description
None	프라이빗 링크가 없습니다(기본값).
Workspace	작업 영역 프라이빗 링크입니다.