External Data Shares Provider - Create External Data Share

서비스:: Core

API 버전:: v1

지정된 항목의 지정된 경로 또는 경로 목록에 대한 외부 데이터 공유를 만듭니다.

Permissions

호출자에게 항목에 대한 읽기 및 다시 공유 권한이 있어야 합니다.

필요한 위임된 범위

항목 API는 토큰에 다음 범위 중 하나를 포함할 수 있습니다.

제네릭 범위: Item.ExternalDataShare.All
특정 범위: itemType. ExternalDataShare.All, 예: Lakehouse.ExternalDataShare.All

범위에 대한 자세한 내용은 범위 문서를 참조하세요.

필수 테넌트 설정

이 API를 사용하려면 호출 주체에 대해 외부 데이터 공유 관리자 스위치를 사용하도록 설정합니다.

Limitations

분당 최대 10개의 요청.

지원되는 항목 유형: Microsoft Fabric에서 외부 데이터 공유를 참조하세요. 지원되는 항목 유형은.

Microsoft Entra 지원 식별자

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

Identity	Support
User	Yes
서비스 주체 및 관리 ID	Yes

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/externalDataShares

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
itemId	path	True	string (uuid)	항목 ID입니다.
workspaceId	path	True	string (uuid)	작업 영역 ID입니다.

요청 본문

Name	필수	형식	Description
paths	True	string[]	외부적으로 공유할 경로 또는 경로 목록입니다. 각 공유에서 최대 100개의 경로를 공유할 수 있습니다. 외부 데이터 공유에 대한 유효한 경로는 "Files/" 또는 "Tables/"로 시작해야 합니다. 루트 폴더 자체(파일 또는 테이블)를 공유할 수 없습니다. 예를 들어 이러한 경로는 유효합니다. "Files/MyFolder1" "Tables/MySchema" "Tables/MyTable1"
recipient	True	ExternalDataShareRecipient	외부 데이터 공유를 수락하도록 초대된 받는 사람입니다.

Name

필수

형식

Description

paths

True

string[]

외부적으로 공유할 경로 또는 경로 목록입니다. 각 공유에서 최대 100개의 경로를 공유할 수 있습니다. 외부 데이터 공유에 대한 유효한 경로는 "Files/" 또는 "Tables/"로 시작해야 합니다. 루트 폴더 자체(파일 또는 테이블)를 공유할 수 없습니다.

예를 들어 이러한 경로는 유효합니다.

"Files/MyFolder1"
"Tables/MySchema"
"Tables/MyTable1"

recipient

True

ExternalDataShareRecipient

외부 데이터 공유를 수락하도록 초대된 받는 사람입니다.

응답

Name	형식	Description
201 Created	ExternalDataShare	성공적으로 만들어졌습니다. 헤더 Location: string
Other Status Codes	ErrorResponse	일반적인 오류 코드: UnknownError - 오류가 발생했습니다.

Name

형식

Description

201 Created

ExternalDataShare

성공적으로 만들어졌습니다.

헤더

Location: string

Other Status Codes

ErrorResponse

일반적인 오류 코드:

UnknownError - 오류가 발생했습니다.

예제

Create an external data share example

Create an external data share with a specific recipient tenant ID example

Create an external data share with multiple paths example

샘플 요청

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715/externalDataShares

{
  "paths": [
    "Files/Sales/Contoso_Sales_2023"
  ],
  "recipient": {
    "userPrincipalName": "lisa@fabrikam.com"
  }
}

샘플 응답

상태 코드:: 201

Location: 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"
}

샘플 요청

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715/externalDataShares

{
  "paths": [
    "Files/Sales/Contoso_Sales_2023"
  ],
  "recipient": {
    "userPrincipalName": "lisa@fabrikam.com",
    "tenantId": "c51dc03f-268a-4da0-a879-25f24947ab8b"
  }
}

샘플 응답

상태 코드:: 201

Location: 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",
    "tenantId": "c51dc03f-268a-4da0-a879-25f24947ab8b"
  },
  "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"
}

샘플 요청

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715/externalDataShares

{
  "paths": [
    "Files/Sales/Contoso_Sales_2023",
    "Files/Sales/Contoso_Sales_2024/SubFolder1",
    "Files/Sales/Contoso_Sales_2024/SubFolder2/SubFolder3"
  ],
  "recipient": {
    "userPrincipalName": "lisa@fabrikam.com"
  }
}

샘플 응답

상태 코드:: 201

Location: 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",
    "Files/Sales/Contoso_Sales_2024/SubFolder1",
    "Files/Sales/Contoso_Sales_2024/SubFolder2/SubFolder3"
  ],
  "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
CreateExternalDataShareRequest	외부 데이터 공유를 만들기 위한 요청 페이로드입니다.
ErrorRelatedResource	오류 관련 리소스 세부 정보 개체입니다.
ErrorResponse	오류 응답입니다.
ErrorResponseDetails	오류 응답 세부 정보입니다.
ExternalDataShare	외부 데이터 공유 개체입니다.
ExternalDataShareRecipient	외부 데이터 공유 받는 사람의 표현입니다.
ExternalDataShareStatus	지정된 외부 데이터 공유의 상태입니다. 추가 `ExternalDataShareStatus` 형식은 시간이 지남에 따라 추가될 수 있습니다.
GroupDetails	특정 세부 정보를 그룹화합니다. 보안 주체 형식이 `Group`경우에 적용됩니다.
GroupType	그룹의 형식입니다. 추가 그룹 유형은 시간이 지남에 따라 추가될 수 있습니다.
Principal	ID 또는 Microsoft Entra 그룹을 나타냅니다.
PrincipalType	보안 주체의 형식입니다. 시간이 지남에 따라 추가 보안 주체 형식을 추가할 수 있습니다.
ServicePrincipalDetails	서비스 주체별 세부 정보입니다. 보안 주체 형식이 `ServicePrincipal`경우에 적용됩니다.
ServicePrincipalProfileDetails	서비스 주체 프로필 세부 정보입니다. 보안 주체 형식이 `ServicePrincipalProfile`경우에 적용됩니다.
UserDetails	사용자 보안 주체별 세부 정보입니다. 보안 주체 형식이 `User`경우에 적용됩니다.

CreateExternalDataShareRequest

Object

외부 데이터 공유를 만들기 위한 요청 페이로드입니다.

Name	형식	Description
paths	string[]	외부적으로 공유할 경로 또는 경로 목록입니다. 각 공유에서 최대 100개의 경로를 공유할 수 있습니다. 외부 데이터 공유에 대한 유효한 경로는 "Files/" 또는 "Tables/"로 시작해야 합니다. 루트 폴더 자체(파일 또는 테이블)를 공유할 수 없습니다. 예를 들어 이러한 경로는 유효합니다. "Files/MyFolder1" "Tables/MySchema" "Tables/MyTable1"
recipient	ExternalDataShareRecipient	외부 데이터 공유를 수락하도록 초대된 받는 사람입니다.

Name

형식

Description

paths

string[]

예를 들어 이러한 경로는 유효합니다.

"Files/MyFolder1"
"Tables/MySchema"
"Tables/MyTable1"

recipient

ExternalDataShareRecipient

외부 데이터 공유를 수락하도록 초대된 받는 사람입니다.

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	오류 관련 리소스 세부 정보입니다.