แชร์ผ่าน

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 แสดงรายการในส่วนนี้

Identity Support
User Yes
บริการหลักและข้อมูลประจําตัว ที่มีการจัดการ Yes

Interface

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

พารามิเตอร์ URI

ชื่อ ใน จำเป็น พิมพ์ คำอธิบาย
itemId
 path True

string (uuid)

รหัสสินค้า
workspaceId
 path True

string (uuid)

ID พื้นที่ทํางาน

เนื้อความของคำขอ

ชื่อ จำเป็น พิมพ์ คำอธิบาย
paths True

string[]

เส้นทางหรือรายการของเส้นทางที่จะแชร์กับภายนอก คุณสามารถแชร์ได้สูงสุด 100 เส้นทางในการแชร์แต่ละครั้ง เส้นทางที่ถูกต้องไปยังการแชร์ข้อมูลภายนอกต้องเริ่มต้นด้วย "ไฟล์/" หรือ "ตาราง/" คุณไม่สามารถแชร์โฟลเดอร์รากได้ (ไฟล์หรือตาราง)

ตัวอย่างเช่น เส้นทางเหล่านี้ถูกต้อง:

  • "Files/MyFolder1"

  • "ตาราง/MySchema"

  • "Tables/MyTable1"
recipient True

ExternalDataShareRecipient

ผู้รับที่ได้รับเชิญให้ยอมรับการแชร์ข้อมูลภายนอก

การตอบสนอง

ชื่อ พิมพ์ คำอธิบาย
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

Create an external data share example

คำขอตัวอย่าง

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

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

คำขอตัวอย่าง

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

Create an external data share with multiple paths example

คำขอตัวอย่าง

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

คำจำกัดความ

ชื่อ คำอธิบาย
CreateExternalDataShareRequest

คําขอส่วนข้อมูลสําหรับการสร้างการแชร์ข้อมูลภายนอก
ErrorRelatedResource

ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ErrorResponse

การตอบสนองข้อผิดพลาด
ErrorResponseDetails

รายละเอียดการตอบสนองข้อผิดพลาด
ExternalDataShare

วัตถุที่แชร์ข้อมูลภายนอก
ExternalDataShareRecipient

การแสดงของผู้รับการแชร์ข้อมูลภายนอก
ExternalDataShareStatus

สถานะของการแชร์ข้อมูลภายนอกที่กําหนด ประเภท ExternalDataShareStatus เพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป
GroupDetails

รายละเอียดเฉพาะของกลุ่ม ใช้ได้เมื่อชนิดหลัก Group
GroupType

ชนิดของกลุ่ม คุณสามารถเพิ่มชนิดกลุ่มเพิ่มเติมเมื่อเวลาผ่านไป
Principal

แสดงข้อมูลประจําตัวหรือกลุ่ม Microsoft Entra
PrincipalType

ชนิดของรายการหลัก คุณสามารถเพิ่มชนิดหลักเพิ่มเติมเมื่อเวลาผ่านไป
ServicePrincipalDetails

รายละเอียดเฉพาะของบริการหลัก ใช้ได้เมื่อชนิดหลัก ServicePrincipal
ServicePrincipalProfileDetails

รายละเอียดโปรไฟล์โครงร่างสําคัญของบริการ ใช้ได้เมื่อชนิดหลัก ServicePrincipalProfile
UserDetails

รายละเอียดเฉพาะของผู้ใช้หลัก ใช้ได้เมื่อชนิดหลัก User

CreateExternalDataShareRequest

ออบเจ็กต์

คําขอส่วนข้อมูลสําหรับการสร้างการแชร์ข้อมูลภายนอก

ชื่อ พิมพ์ คำอธิบาย
paths

string[]

เส้นทางหรือรายการของเส้นทางที่จะแชร์กับภายนอก คุณสามารถแชร์ได้สูงสุด 100 เส้นทางในการแชร์แต่ละครั้ง เส้นทางที่ถูกต้องไปยังการแชร์ข้อมูลภายนอกต้องเริ่มต้นด้วย "ไฟล์/" หรือ "ตาราง/" คุณไม่สามารถแชร์โฟลเดอร์รากได้ (ไฟล์หรือตาราง)

ตัวอย่างเช่น เส้นทางเหล่านี้ถูกต้อง:

  • "Files/MyFolder1"

  • "ตาราง/MySchema"

  • "Tables/MyTable1"
recipient

ExternalDataShareRecipient

ผู้รับที่ได้รับเชิญให้ยอมรับการแชร์ข้อมูลภายนอก

ErrorRelatedResource

ออบเจ็กต์

ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ชื่อ พิมพ์ คำอธิบาย
resourceId

string

ID ทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
resourceType

string

ชนิดของทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponse

ออบเจ็กต์

การตอบสนองข้อผิดพลาด

ชื่อ พิมพ์ คำอธิบาย
errorCode

string

ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message

string

การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
moreDetails

ErrorResponseDetails[]

รายการรายละเอียดข้อผิดพลาดเพิ่มเติม
relatedResource

ErrorRelatedResource

รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
requestId

string

รหัสของคําขอที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponseDetails

ออบเจ็กต์

รายละเอียดการตอบสนองข้อผิดพลาด

ชื่อ พิมพ์ คำอธิบาย
errorCode

string

ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message

string

การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
relatedResource

ErrorRelatedResource

รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ExternalDataShare

ออบเจ็กต์

วัตถุที่แชร์ข้อมูลภายนอก

ชื่อ พิมพ์ คำอธิบาย
acceptedByTenantId

string (uuid)

ID ผู้เช่าที่ยอมรับการแชร์ข้อมูลภายนอก
creatorPrincipal

Principal

องค์ประกอบหลักที่สร้างการแชร์ข้อมูลภายนอก
expirationTimeUtc

string (date-time)

วันที่และเวลาหมดอายุ (UTC) ของคําเชิญให้แชร์ข้อมูลภายนอก
id

string (uuid)

ID การแชร์ข้อมูลภายนอก
invitationUrl

string (uri)

URL สําหรับการยอมรับคําเชิญไปยังการแชร์ข้อมูลภายนอก
itemId

string (uuid)

รหัสสินค้า
paths

string[]

เส้นทางหรือรายการของเส้นทางที่ใช้ร่วมกันภายนอก
recipient

ExternalDataShareRecipient

ผู้รับที่ได้รับเชิญให้ยอมรับการแชร์ข้อมูลภายนอก
status

ExternalDataShareStatus

สถานะของการแชร์ข้อมูลภายนอก
workspaceId

string (uuid)

ID พื้นที่ทํางาน

ExternalDataShareRecipient

ออบเจ็กต์

การแสดงของผู้รับการแชร์ข้อมูลภายนอก

ชื่อ พิมพ์ คำอธิบาย
tenantId

string (uuid)

รหัสผู้เช่าของผู้รับ
userPrincipalName

string

maxLength: 256

ที่อยู่อีเมลของผู้รับ

ExternalDataShareStatus

การแจงนับ

สถานะของการแชร์ข้อมูลภายนอกที่กําหนด ประเภท ExternalDataShareStatus เพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป

ค่า คำอธิบาย
Pending

คําเชิญถูกสร้างขึ้น และขณะนี้กําลังรอการยอมรับโดยผู้รับ
Active

ผู้รับยอมรับคําเชิญแล้วและการแชร์ข้อมูลภายนอกทํางานอยู่
Revoked

การแชร์ข้อมูลภายนอกถูกเพิกถอน
InvitationExpired

คําเชิญหมดอายุแล้วและผู้รับไม่ยอมรับอีกต่อไป

GroupDetails

ออบเจ็กต์

รายละเอียดเฉพาะของกลุ่ม ใช้ได้เมื่อชนิดหลัก Group

ชื่อ พิมพ์ คำอธิบาย
groupType

GroupType

ชนิดของกลุ่ม คุณสามารถเพิ่มชนิดกลุ่มเพิ่มเติมเมื่อเวลาผ่านไป

GroupType

การแจงนับ

ชนิดของกลุ่ม คุณสามารถเพิ่มชนิดกลุ่มเพิ่มเติมเมื่อเวลาผ่านไป

ค่า คำอธิบาย
Unknown

ไม่รู้จักชนิดกลุ่มหลัก
SecurityGroup

หลักคือกลุ่มความปลอดภัย
DistributionList

หลักคือรายการการแจกจ่าย

Principal

ออบเจ็กต์

แสดงข้อมูลประจําตัวหรือกลุ่ม Microsoft Entra

ชื่อ พิมพ์ คำอธิบาย
displayName

string

ชื่อที่แสดงขององค์ประกอบหลัก
groupDetails

GroupDetails

รายละเอียดเฉพาะของกลุ่ม ใช้ได้เมื่อชนิดหลัก Group
id

string (uuid)

ID ของโครงร่างสําคัญ
servicePrincipalDetails

ServicePrincipalDetails

รายละเอียดเฉพาะของบริการหลัก ใช้ได้เมื่อชนิดหลัก ServicePrincipal
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

รายละเอียดโปรไฟล์โครงร่างสําคัญของบริการ ใช้ได้เมื่อชนิดหลัก ServicePrincipalProfile
type

PrincipalType

ชนิดของรายการหลัก คุณสามารถเพิ่มชนิดหลักเพิ่มเติมเมื่อเวลาผ่านไป
userDetails

UserDetails

รายละเอียดเฉพาะของผู้ใช้หลัก ใช้ได้เมื่อชนิดหลัก User

PrincipalType

การแจงนับ

ชนิดของรายการหลัก คุณสามารถเพิ่มชนิดหลักเพิ่มเติมเมื่อเวลาผ่านไป

ค่า คำอธิบาย
User

หลักคือผู้ใช้หลัก Microsoft Entra
ServicePrincipal

หลักคือโครงร่างสําคัญของบริการ Microsoft Entra
Group

หลักคือกลุ่มความปลอดภัย
ServicePrincipalProfile

หลักคือ โปรไฟล์โครงร่างสําคัญของบริการ
EntireTenant

หลักแสดงผู้ใช้ที่เป็นผู้เช่าทั้งหมด

ServicePrincipalDetails

ออบเจ็กต์

รายละเอียดเฉพาะของบริการหลัก ใช้ได้เมื่อชนิดหลัก ServicePrincipal

ชื่อ พิมพ์ คำอธิบาย
aadAppId

string (uuid)

Microsoft Entra AppId ของบริการหลัก

ServicePrincipalProfileDetails

ออบเจ็กต์

รายละเอียดโปรไฟล์โครงร่างสําคัญของบริการ ใช้ได้เมื่อชนิดหลัก ServicePrincipalProfile

ชื่อ พิมพ์ คำอธิบาย
parentPrincipal

Principal

โครงร่างสําคัญของโปรไฟล์บริการหลัก

UserDetails

ออบเจ็กต์

รายละเอียดเฉพาะของผู้ใช้หลัก ใช้ได้เมื่อชนิดหลัก User

ชื่อ พิมพ์ คำอธิบาย
userPrincipalName

string

ชื่อหลักของผู้ใช้