External Data Shares Provider - Get External Data Share
지정된 외부 데이터 공유의 세부 정보를 반환합니다.
권한
호출자에게 항목에 대한 읽기 및 다시 공유 권한이 있어야 합니다.
필요한 위임된 범위
항목 API는 토큰에 다음 범위 중 하나를 포함할 수 있습니다.
- 제네릭 범위: Item.ExternalDataShare.All
- 특정 범위: itemType. ExternalDataShare.All, 예: Lakehouse.ExternalDataShare.All
범위에 대한 자세한 내용은 범위 문서참조하세요.
필수 테넌트 설정
이 API를 사용하려면 호출 주체에 대해 외부 데이터 공유 관리자 스위치를 사용하도록 설정합니다.
제한점
분당 최대 10개의 요청.
Microsoft Entra 지원 식별자
이 API는 이 섹션에 나열된 Microsoft ID 지원합니다.
| 아이덴티티 | 지원 |
|---|---|
| 사용자 | 예 |
| 서비스 주체 및 관리 ID | 예 |
인터페이스
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/externalDataShares/{externalDataShareId}
URI 매개 변수
| Name | In(다음 안에) | 필수 | 형식 | Description |
|---|---|---|---|---|
|
external
|
path | True |
string (uuid) |
외부 데이터 공유 ID입니다. |
|
item
|
path | True |
string (uuid) |
항목 ID입니다. |
|
workspace
|
path | True |
string (uuid) |
작업 영역 ID입니다. |
응답
| Name | 형식 | Description |
|---|---|---|
| 200 OK |
요청이 성공적으로 완료되었습니다. |
|
| Other Status Codes |
일반적인 오류 코드:
|
예제
Get external data share example
샘플 요청
GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715/externalDataShares/dccc162f-7a41-4720-83c3-5c7e81187959
샘플 응답
{
"id": "dccc162f-7a41-4720-83c3-5c7e81187959",
"paths": [
"Files/Sales/Contoso_Sales_2023"
],
"creatorPrincipal": {
"id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
"type": "User"
},
"recipient": {
"userPrincipalName": "lisa@fabrikam.com"
},
"status": "Pending",
"expirationTimeUtc": "2024-12-13T00:00:00.000Z",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"itemId": "5b218778-e7a5-4d73-8187-f10824047715",
"invitationUrl": "https://app.fabric.microsoft.com/externaldatasharing/accept?providerTenantId=34f92457-fe9d-4c36-92a8-499fdfaf0f8f&shareId=dccc162f-7a41-4720-83c3-5c7e81187959"
}
정의
| Name | Description |
|---|---|
|
Error |
오류 관련 리소스 세부 정보 개체입니다. |
|
Error |
오류 응답입니다. |
|
Error |
오류 응답 세부 정보입니다. |
|
External |
외부 데이터 공유 개체입니다. |
|
External |
외부 데이터 공유 받는 사람의 표현입니다. |
|
External |
지정된 외부 데이터 공유의 상태입니다. 추가 |
|
Group |
특정 세부 정보를 그룹화합니다. 보안 주체 형식이 |
|
Group |
그룹의 형식입니다. 추가 그룹 유형은 시간이 지남에 따라 추가될 수 있습니다. |
| Principal |
ID 또는 Microsoft Entra 그룹을 나타냅니다. |
|
Principal |
보안 주체의 형식입니다. 시간이 지남에 따라 추가 보안 주체 형식을 추가할 수 있습니다. |
|
Service |
서비스 주체별 세부 정보입니다. 보안 주체 형식이 |
|
Service |
서비스 주체 프로필 세부 정보입니다. 보안 주체 형식이 |
|
User |
사용자 보안 주체별 세부 정보입니다. 보안 주체 형식이 |
ErrorRelatedResource
오류 관련 리소스 세부 정보 개체입니다.
| Name | 형식 | Description |
|---|---|---|
| resourceId |
string |
오류와 관련된 리소스 ID입니다. |
| resourceType |
string |
오류와 관련된 리소스의 형식입니다. |
ErrorResponse
오류 응답입니다.
| Name | 형식 | Description |
|---|---|---|
| errorCode |
string |
오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다. |
| message |
string |
사용자가 읽을 수 있는 오류 표현입니다. |
| moreDetails |
추가 오류 세부 정보 목록입니다. |
|
| relatedResource |
오류 관련 리소스 세부 정보입니다. |
|
| requestId |
string |
오류와 연결된 요청의 ID입니다. |
ErrorResponseDetails
오류 응답 세부 정보입니다.
| Name | 형식 | Description |
|---|---|---|
| errorCode |
string |
오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다. |
| message |
string |
사용자가 읽을 수 있는 오류 표현입니다. |
| relatedResource |
오류 관련 리소스 세부 정보입니다. |
ExternalDataShare
외부 데이터 공유 개체입니다.
| Name | 형식 | Description |
|---|---|---|
| acceptedByTenantId |
string (uuid) |
외부 데이터 공유가 허용된 테넌트 ID입니다. |
| creatorPrincipal |
외부 데이터 공유를 만든 보안 주체입니다. |
|
| expirationTimeUtc |
string (date-time) |
외부 데이터 공유에 대한 초대의 만료 날짜 및 시간(UTC)입니다. |
| id |
string (uuid) |
외부 데이터 공유 ID입니다. |
| invitationUrl |
string (uri) |
외부 데이터 공유에 대한 초대를 수락하기 위한 URL입니다. |
| itemId |
string (uuid) |
항목 ID입니다. |
| paths |
string[] |
외부에서 공유되는 경로 또는 경로 목록입니다. |
| recipient |
외부 데이터 공유를 수락하도록 초대된 받는 사람입니다. |
|
| status |
외부 데이터 공유의 상태입니다. |
|
| workspaceId |
string (uuid) |
작업 영역 ID입니다. |
ExternalDataShareRecipient
외부 데이터 공유 받는 사람의 표현입니다.
| Name | 형식 | Description |
|---|---|---|
| tenantId |
string (uuid) |
받는 사람의 테넌트 ID입니다. |
| userPrincipalName |
string maxLength: 256 |
받는 사람의 전자 메일 주소입니다. |
ExternalDataShareStatus
지정된 외부 데이터 공유의 상태입니다. 추가 ExternalDataShareStatus 형식은 시간이 지남에 따라 추가될 수 있습니다.
| 값 | Description |
|---|---|
| Pending |
초대가 만들어졌으며 현재 받는 사람이 수락을 보류 중입니다. |
| Active |
받는 사람이 초대를 수락했으며 외부 데이터 공유가 활성 상태입니다. |
| Revoked |
외부 데이터 공유가 취소되었습니다. |
| InvitationExpired |
초대가 만료되어 받는 사람이 더 이상 수락할 수 없습니다. |
GroupDetails
특정 세부 정보를 그룹화합니다. 보안 주체 형식이 Group경우에 적용됩니다.
| Name | 형식 | Description |
|---|---|---|
| groupType |
그룹의 형식입니다. 추가 그룹 유형은 시간이 지남에 따라 추가될 수 있습니다. |
GroupType
그룹의 형식입니다. 추가 그룹 유형은 시간이 지남에 따라 추가될 수 있습니다.
| 값 | Description |
|---|---|
| Unknown |
보안 주체 그룹 유형을 알 수 없습니다. |
| SecurityGroup |
보안 주체는 보안 그룹입니다. |
| DistributionList |
보안 주체는 메일 그룹입니다. |
Principal
ID 또는 Microsoft Entra 그룹을 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| displayName |
string |
보안 주체의 표시 이름입니다. |
| groupDetails |
특정 세부 정보를 그룹화합니다. 보안 주체 형식이 |
|
| id |
string (uuid) |
보안 주체의 ID입니다. |
| servicePrincipalDetails |
서비스 주체별 세부 정보입니다. 보안 주체 형식이 |
|
| servicePrincipalProfileDetails |
서비스 주체 프로필 세부 정보입니다. 보안 주체 형식이 |
|
| type |
보안 주체의 형식입니다. 시간이 지남에 따라 추가 보안 주체 형식을 추가할 수 있습니다. |
|
| userDetails |
사용자 보안 주체별 세부 정보입니다. 보안 주체 형식이 |
PrincipalType
보안 주체의 형식입니다. 시간이 지남에 따라 추가 보안 주체 형식을 추가할 수 있습니다.
| 값 | Description |
|---|---|
| User |
보안 주체는 Microsoft Entra 사용자 보안 주체입니다. |
| ServicePrincipal |
보안 주체는 Microsoft Entra 서비스 주체입니다. |
| Group |
보안 주체는 보안 그룹입니다. |
| ServicePrincipalProfile |
보안 주체는 서비스 주체 프로필입니다. |
| EntireTenant |
보안 주체는 모든 테넌트 사용자를 나타냅니다. |
ServicePrincipalDetails
서비스 주체별 세부 정보입니다. 보안 주체 형식이 ServicePrincipal경우에 적용됩니다.
| Name | 형식 | Description |
|---|---|---|
| aadAppId |
string (uuid) |
서비스 주체의 Microsoft Entra AppId입니다. |
ServicePrincipalProfileDetails
서비스 주체 프로필 세부 정보입니다. 보안 주체 형식이 ServicePrincipalProfile경우에 적용됩니다.
| Name | 형식 | Description |
|---|---|---|
| parentPrincipal |
서비스 주체 프로필의 부모 보안 주체입니다. |
UserDetails
사용자 보안 주체별 세부 정보입니다. 보안 주체 형식이 User경우에 적용됩니다.
| Name | 형식 | Description |
|---|---|---|
| userPrincipalName |
string |
사용자 계정 이름입니다. |