Items - Associate Identity (beta)

บริการ:: Core

เวอร์ชัน API:: v1

เชื่อมโยงข้อมูลประจําตัวเริ่มต้นกับรายการ

Note

API นี้เป็นส่วนหนึ่งของการเผยแพร่รุ่นเบต้า และมีไว้สําหรับวัตถุประสงค์ในการประเมินและการพัฒนาเท่านั้น ซึ่งอาจเปลี่ยนแปลงตามคําติชมและไม่แนะนําสําหรับการใช้งานด้านการผลิต เมื่อเรียกใช้ API นี้ ผู้เรียกต้องระบุ true เป็นค่าสําหรับพารามิเตอร์ betaคิวรี

API นี้สนับสนุน การดําเนินการที่ใช้เวลานาน (LRO)

API นี้ได้รับการสนับสนุนสําหรับจํานวนของชนิดรายการ ค้นหาประเภทหน่วยข้อมูลที่สนับสนุนและข้อมูลเกี่ยวกับโครงสร้างข้อกําหนดของพวกเขาในภาพรวมการจัดการรายการ

การอนุญาต

ผู้เรียกต้องมีสิทธิ์ ในการอ่านและเขียน สําหรับรายการ

จําเป็นต้องมีขอบเขตที่ได้รับมอบสิทธิ์

สําหรับรายการ API ใช้ชนิดขอบเขตเหล่านี้:

ขอบเขตทั่วไป: Item.ReadWrite.All
ขอบเขตเฉพาะ: itemTypeReadWrite.All (ตัวอย่างเช่น: Notebook.ReadWrite.All)

สําหรับข้อมูลเพิ่มเติมเกี่ยวกับขอบเขต โปรดดู: บทความขอบเขต

Microsoft Entra ข้อมูลประจําตัวที่ได้รับการสนับสนุน

API นี้สนับสนุน Microsoft identitiesที่ระบุในส่วนนี้

Identity	การสนับสนุน
ผู้ใช้	ใข่
บริการหลักและข้อมูลประจําตัว ที่มีการจัดการ	เมื่อชนิดรายการในการเรียกใช้ได้รับการสนับสนุน ตรวจสอบ API ที่สอดคล้องกันสําหรับชนิดรายการที่คุณกําลังเรียกใช้ เพื่อดูว่าการเรียกใช้ของคุณรองรับหรือไม่

Identity

การสนับสนุน

ผู้ใช้

ใข่

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

เมื่อชนิดรายการในการเรียกใช้ได้รับการสนับสนุน ตรวจสอบ API ที่สอดคล้องกันสําหรับชนิดรายการที่คุณกําลังเรียกใช้ เพื่อดูว่าการเรียกใช้ของคุณรองรับหรือไม่

ส่วนติดต่อ

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/identities/default/assign?beta={beta}

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

ชื่อ	ใน	จำเป็น	พิมพ์	คำอธิบาย
itemId	path	True	string (uuid)	รหัสสินค้า
workspaceId	path	True	string (uuid)	ID พื้นที่ทํางาน
beta	query	True	boolean	ต้องตั้งค่าพารามิเตอร์ที่จําเป็นนี้เพื่อ `true` เข้าถึง API นี้ ซึ่งอยู่ในรุ่นเบต้าในขณะนี้

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

ชื่อ	จำเป็น	พิมพ์	คำอธิบาย
assignmentType	True	IdentityAssignmentEntityType	ชนิดของชื่อเรื่องที่สร้างคําขอข้อมูลประจําตัวแบบอสโกไลต์

การตอบสนอง

ชื่อ	พิมพ์	คำอธิบาย
200 OK	UpdateItemIdentityResponse	คําขอเสร็จสมบูรณ์
202 Accepted		การร้องขอที่ยอมรับได้ ความสัมพันธ์ของข้อมูลประจําตัวกําลังอยู่ระหว่างดําเนินการ ส่วนหัว Location: string Retry-After: integer
429 Too Many Requests	ErrorResponse	เกินขีดจํากัดอัตราการบริการ เซิร์ฟเวอร์จะส่งกลับ `Retry-After` ส่วนหัวที่ระบุ ภายในไม่กี่วินาที ระยะเวลาที่ไคลเอ็นต์ต้องรอก่อนที่จะส่งคําขอเพิ่มเติม ส่วนหัว Retry-After: integer
Other Status Codes	ErrorResponse	รหัสข้อผิดพลาดทั่วไป: ItemNotFound - ไม่พบรายการที่ร้องขอ InvalidRequest - การร้องขอความสัมพันธ์ไม่ถูกต้อง

ตัวอย่าง

Associate identity example

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

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715/identities/default/assign?beta=True

{
  "assignmentType": "Caller"
}

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

รหัสสถานะ:: 200

{
  "assignmentStatus": [
    {
      "itemId": "eab1679a-8cab-40d6-9ba6-5c2a07a7ce81",
      "status": "Succeeded"
    },
    {
      "itemId": "8eedb1b0-3af8-4b17-8e7e-663e61e12211",
      "parentItemId": "eab1679a-8cab-40d6-9ba6-5c2a07a7ce81",
      "status": "Succeeded"
    },
    {
      "itemId": "83b128a3-f58f-4eee-ab0b-e7e25a748f54",
      "parentItemId": "eab1679a-8cab-40d6-9ba6-5c2a07a7ce81",
      "status": "Failed",
      "errorInfo": {
        "errorCode": "AssignmentFailed",
        "message": "The assignment operation failed due to insufficient permissions."
      }
    }
  ]
}

รหัสสถานะ:: 202

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

คำจำกัดความ

ชื่อ	คำอธิบาย
ErrorRelatedResource	ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ErrorResponse	การตอบสนองข้อผิดพลาด
ErrorResponseDetails	รายละเอียดการตอบสนองข้อผิดพลาด
IdentityAssignmentEntityType	ชนิดของชื่อเรื่องที่สร้างคําขอข้อมูลประจําตัวแบบอสโกไลต์
IdentityAssignmentStatusType	สถานะของการกําหนดข้อมูลประจําตัว สถานะเพิ่มเติมอาจถูกเพิ่มเมื่อเวลาผ่านไป
ItemAssignmentStatus	สถานะของการกําหนดข้อมูลประจําตัวให้กับรายการ
UpdateItemIdentityRequest	เชื่อมโยงส่วนข้อมูลคําขอข้อมูลประจําตัว
UpdateItemIdentityResponse	เชื่อมโยงการตอบสนองข้อมูลประจําตัว

ErrorRelatedResource

วัตถุ

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

ชื่อ	พิมพ์	คำอธิบาย
resourceId	string	ID ทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
resourceType	string	ชนิดของทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponse

วัตถุ

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

ชื่อ	พิมพ์	คำอธิบาย
errorCode	string	ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message	string	การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
moreDetails	ErrorResponseDetails[]	รายการรายละเอียดข้อผิดพลาดเพิ่มเติม
relatedResource	ErrorRelatedResource	รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
requestId	string (uuid)	รหัสของคําขอที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponseDetails

วัตถุ

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

ชื่อ	พิมพ์	คำอธิบาย
errorCode	string	ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message	string	การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
relatedResource	ErrorRelatedResource	รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

IdentityAssignmentEntityType

การแจงนับ

ชนิดของชื่อเรื่องที่สร้างคําขอข้อมูลประจําตัวแบบอสโกไลต์

ค่า	คำอธิบาย
Caller	ผู้ใช้หรือบริการหลักที่ทําการร้องขอข้อมูลประจําตัวที่เชื่อมโยง

IdentityAssignmentStatusType

การแจงนับ

สถานะของการกําหนดข้อมูลประจําตัว สถานะเพิ่มเติมอาจถูกเพิ่มเมื่อเวลาผ่านไป

ค่า	คำอธิบาย
Succeeded	มีการกําหนดข้อมูลประจําตัวให้กับรายการเรียบร้อยแล้ว
Failed	การกําหนดข้อมูลประจําตัวล้มเหลว

ItemAssignmentStatus

วัตถุ

สถานะของการกําหนดข้อมูลประจําตัวให้กับรายการ

ชื่อ	พิมพ์	คำอธิบาย
errorInfo	ErrorResponseDetails	ข้อมูลข้อผิดพลาดถ้าการกําหนดข้อมูลประจําตัวล้มเหลว
itemId	string (uuid)	รหัสของสินค้า
parentItemId	string (uuid)	รหัสของรายการหลัก
status	IdentityAssignmentStatusType	สถานะของการกําหนดข้อมูลประจําตัว สถานะเพิ่มเติมอาจถูกเพิ่มเมื่อเวลาผ่านไป

UpdateItemIdentityRequest

วัตถุ

เชื่อมโยงส่วนข้อมูลคําขอข้อมูลประจําตัว

ชื่อ	พิมพ์	คำอธิบาย
assignmentType	IdentityAssignmentEntityType	ชนิดของชื่อเรื่องที่สร้างคําขอข้อมูลประจําตัวแบบอสโกไลต์

UpdateItemIdentityResponse

วัตถุ

เชื่อมโยงการตอบสนองข้อมูลประจําตัว

ชื่อ	พิมพ์	คำอธิบาย
assignmentStatus	ItemAssignmentStatus[]	ข้อมูลประจําตัวที่กําหนดให้กับรายการหลังจากการอัปเดต