External Data Shares Provider - Get External Data Share
ส่งกลับรายละเอียดของการแชร์ข้อมูลภายนอกที่ระบุ
สิทธิ์
ผู้เรียกต้องมีสิทธิ์ ในการอ่าน และ แชร์ ต่อบนรายการ
จําเป็นต้องมีขอบเขตที่ได้รับมอบสิทธิ์
รายการ API สามารถมีขอบเขตเหล่านี้ในโทเค็นของพวกเขาได้:
- ขอบเขตทั่วไป: Item.ExternalDataShare.All
- ขอบเขตเฉพาะ: itemType ExternalDataShare.All ตัวอย่างเช่น: Lakehouse.ExternalDataShare.All
สําหรับข้อมูลเพิ่มเติมเกี่ยวกับขอบเขต โปรดดูบทความขอบเขต
การตั้งค่าผู้เช่าที่จําเป็น
หากต้องการใช้ API นี้ ให้เปิดใช้งานสวิตช์ผู้ดูแลระบบ การแชร์ข้อมูลภายนอก สําหรับองค์ประกอบหลักของการเรียก
ข้อจำกัด
สูงสุด 10 คําขอต่อนาที
ข้อมูลประจําตัวที่สนับสนุนของ Microsoft Entra
API นี้สนับสนุนข้อมูลประจําตัวของ Microsoft แสดงรายการในส่วนนี้
| เอกลักษณ์ | สนับสนุน |
|---|---|
| ผู้ใช้ | ใช่ |
| บริการหลักและข้อมูลประจําตัว ที่มีการจัดการ | ใช่ |
อิน เทอร์ เฟซ
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/externalDataShares/{externalDataShareId}
พารามิเตอร์ URI
| ชื่อ | ใน | จำเป็น | พิมพ์ | คำอธิบาย |
|---|---|---|---|---|
|
external
|
path | True |
string (uuid) |
ID การแชร์ข้อมูลภายนอก |
|
item
|
path | True |
string (uuid) |
รหัสสินค้า |
|
workspace
|
path | True |
string (uuid) |
ID พื้นที่ทํางาน |
การตอบสนอง
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| 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"
}
คำจำกัดความ
| ชื่อ | คำอธิบาย |
|---|---|
|
Error |
ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |
|
Error |
การตอบสนองข้อผิดพลาด |
|
Error |
รายละเอียดการตอบสนองข้อผิดพลาด |
|
External |
วัตถุที่แชร์ข้อมูลภายนอก |
|
External |
การแสดงของผู้รับการแชร์ข้อมูลภายนอก |
|
External |
สถานะของการแชร์ข้อมูลภายนอกที่กําหนด ประเภท |
|
Group |
รายละเอียดเฉพาะของกลุ่ม ใช้ได้เมื่อชนิดหลัก |
|
Group |
ชนิดของกลุ่ม คุณสามารถเพิ่มชนิดกลุ่มเพิ่มเติมเมื่อเวลาผ่านไป |
| Principal |
แสดงข้อมูลประจําตัวหรือกลุ่ม Microsoft Entra |
|
Principal |
ชนิดของรายการหลัก คุณสามารถเพิ่มชนิดหลักเพิ่มเติมเมื่อเวลาผ่านไป |
|
Service |
รายละเอียดเฉพาะของบริการหลัก ใช้ได้เมื่อชนิดหลัก |
|
Service |
รายละเอียดโปรไฟล์โครงร่างสําคัญของบริการ ใช้ได้เมื่อชนิดหลัก |
|
User |
รายละเอียดเฉพาะของผู้ใช้หลัก ใช้ได้เมื่อชนิดหลัก |
ErrorRelatedResource
ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| resourceId |
string |
ID ทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |
| resourceType |
string |
ชนิดของทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |
ErrorResponse
การตอบสนองข้อผิดพลาด
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| errorCode |
string |
ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้ |
| message |
string |
การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้ |
| moreDetails |
รายการรายละเอียดข้อผิดพลาดเพิ่มเติม |
|
| relatedResource |
รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |
|
| requestId |
string |
รหัสของคําขอที่เกี่ยวข้องกับข้อผิดพลาด |
ErrorResponseDetails
รายละเอียดการตอบสนองข้อผิดพลาด
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| errorCode |
string |
ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้ |
| message |
string |
การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้ |
| relatedResource |
รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |
ExternalDataShare
วัตถุที่แชร์ข้อมูลภายนอก
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| acceptedByTenantId |
string (uuid) |
ID ผู้เช่าที่ยอมรับการแชร์ข้อมูลภายนอก |
| creatorPrincipal |
องค์ประกอบหลักที่สร้างการแชร์ข้อมูลภายนอก |
|
| expirationTimeUtc |
string (date-time) |
วันที่และเวลาหมดอายุ (UTC) ของคําเชิญให้แชร์ข้อมูลภายนอก |
| id |
string (uuid) |
ID การแชร์ข้อมูลภายนอก |
| invitationUrl |
string (uri) |
URL สําหรับการยอมรับคําเชิญไปยังการแชร์ข้อมูลภายนอก |
| itemId |
string (uuid) |
รหัสสินค้า |
| paths |
string[] |
เส้นทางหรือรายการของเส้นทางที่ใช้ร่วมกันภายนอก |
| recipient |
ผู้รับที่ได้รับเชิญให้ยอมรับการแชร์ข้อมูลภายนอก |
|
| status |
สถานะของการแชร์ข้อมูลภายนอก |
|
| workspaceId |
string (uuid) |
ID พื้นที่ทํางาน |
ExternalDataShareRecipient
การแสดงของผู้รับการแชร์ข้อมูลภายนอก
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| tenantId |
string (uuid) |
รหัสผู้เช่าของผู้รับ |
| userPrincipalName |
string maxLength: 256 |
ที่อยู่อีเมลของผู้รับ |
ExternalDataShareStatus
สถานะของการแชร์ข้อมูลภายนอกที่กําหนด ประเภท ExternalDataShareStatus เพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป
| ค่า | คำอธิบาย |
|---|---|
| Pending |
คําเชิญถูกสร้างขึ้น และขณะนี้กําลังรอการยอมรับโดยผู้รับ |
| Active |
ผู้รับยอมรับคําเชิญแล้วและการแชร์ข้อมูลภายนอกทํางานอยู่ |
| Revoked |
การแชร์ข้อมูลภายนอกถูกเพิกถอน |
| InvitationExpired |
คําเชิญหมดอายุแล้วและผู้รับไม่ยอมรับอีกต่อไป |
GroupDetails
รายละเอียดเฉพาะของกลุ่ม ใช้ได้เมื่อชนิดหลัก Group
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| groupType |
ชนิดของกลุ่ม คุณสามารถเพิ่มชนิดกลุ่มเพิ่มเติมเมื่อเวลาผ่านไป |
GroupType
ชนิดของกลุ่ม คุณสามารถเพิ่มชนิดกลุ่มเพิ่มเติมเมื่อเวลาผ่านไป
| ค่า | คำอธิบาย |
|---|---|
| Unknown |
ไม่รู้จักชนิดกลุ่มหลัก |
| SecurityGroup |
หลักคือกลุ่มความปลอดภัย |
| DistributionList |
หลักคือรายการการแจกจ่าย |
Principal
แสดงข้อมูลประจําตัวหรือกลุ่ม Microsoft Entra
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| displayName |
string |
ชื่อที่แสดงขององค์ประกอบหลัก |
| groupDetails |
รายละเอียดเฉพาะของกลุ่ม ใช้ได้เมื่อชนิดหลัก |
|
| id |
string (uuid) |
ID ของโครงร่างสําคัญ |
| servicePrincipalDetails |
รายละเอียดเฉพาะของบริการหลัก ใช้ได้เมื่อชนิดหลัก |
|
| servicePrincipalProfileDetails |
รายละเอียดโปรไฟล์โครงร่างสําคัญของบริการ ใช้ได้เมื่อชนิดหลัก |
|
| type |
ชนิดของรายการหลัก คุณสามารถเพิ่มชนิดหลักเพิ่มเติมเมื่อเวลาผ่านไป |
|
| userDetails |
รายละเอียดเฉพาะของผู้ใช้หลัก ใช้ได้เมื่อชนิดหลัก |
PrincipalType
ชนิดของรายการหลัก คุณสามารถเพิ่มชนิดหลักเพิ่มเติมเมื่อเวลาผ่านไป
| ค่า | คำอธิบาย |
|---|---|
| User |
หลักคือผู้ใช้หลัก Microsoft Entra |
| ServicePrincipal |
หลักคือโครงร่างสําคัญของบริการ Microsoft Entra |
| Group |
หลักคือกลุ่มความปลอดภัย |
| ServicePrincipalProfile |
หลักคือ โปรไฟล์โครงร่างสําคัญของบริการ |
| EntireTenant |
หลักแสดงผู้ใช้ที่เป็นผู้เช่าทั้งหมด |
ServicePrincipalDetails
รายละเอียดเฉพาะของบริการหลัก ใช้ได้เมื่อชนิดหลัก ServicePrincipal
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| aadAppId |
string (uuid) |
Microsoft Entra AppId ของบริการหลัก |
ServicePrincipalProfileDetails
รายละเอียดโปรไฟล์โครงร่างสําคัญของบริการ ใช้ได้เมื่อชนิดหลัก ServicePrincipalProfile
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| parentPrincipal |
โครงร่างสําคัญของโปรไฟล์บริการหลัก |
UserDetails
รายละเอียดเฉพาะของผู้ใช้หลัก ใช้ได้เมื่อชนิดหลัก User
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| userPrincipalName |
string |
ชื่อหลักของผู้ใช้ |