Workspaces - Provision Identity

บริการ:: Core

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

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

Permissions

ผู้เรียกต้องมีบทบาท ผู้ดูแลระบบ ในพื้นที่ทํางาน

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

Workspace.ReadWrite.All

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

API นี้สนับสนุนข้อมูลประจําตัวของ Microsoft แสดงรายการในส่วนนี้

เอกลักษณ์	Support
ผู้ใช้	Yes
บริการหลักและข้อมูลประจําตัว ที่มีการจัดการ	Yes

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/provisionIdentity

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

ชื่อ	ใน	จำเป็น	พิมพ์	คำอธิบาย
workspaceId	path	True	string (uuid)	ID ของพื้นที่ทํางาน

การตอบสนอง

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

ตัวอย่าง

Provision workspace identity example

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

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227/provisionIdentity

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

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

{
  "applicationId": "00a4a8f9-78d3-41b3-b87a-6ae5271c8d0d",
  "servicePrincipalId": "5ba4ae58-d402-45c6-a848-0253e834fd78",
  "identityReference": {
    "referenceType": "ById",
    "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
    "itemId": "4a1d86e3-d740-4610-b32d-7bae87d33e9d"
  }
}

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

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 5

คำจำกัดความ

ชื่อ	คำอธิบาย
ErrorParameter	พารามิเตอร์ที่มีโครงสร้างให้บริบทที่สามารถอ่านได้ด้วยเครื่องเพิ่มเติมเกี่ยวกับข้อผิดพลาด
ErrorRelatedResource	ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ErrorResponse	การตอบสนองข้อผิดพลาด
ErrorResponseDetails	รายละเอียดการตอบสนองข้อผิดพลาด
ItemReferenceById	การอ้างอิงรายการตามออบเจ็กต์ ID
ItemReferenceByVariable	การอ้างอิงรายการตามตัวแปร
ItemReferenceType	ชนิดการอ้างอิงสินค้า ประเภท `ItemReferenceType` เพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป
WorkspaceIdentity	ออบเจ็กต์ข้อมูลประจําตัวของพื้นที่ทํางาน

ErrorParameter

วัตถุ

พารามิเตอร์ที่มีโครงสร้างให้บริบทที่สามารถอ่านได้ด้วยเครื่องเพิ่มเติมเกี่ยวกับข้อผิดพลาด

ชื่อ	พิมพ์	คำอธิบาย
message	string	คําอธิบายที่มนุษย์สามารถอ่านได้ของความหมายของพารามิเตอร์
name	string	ตัวระบุพารามิเตอร์
value	string	ค่าพารามิเตอร์

ErrorRelatedResource

วัตถุ

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

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

ErrorResponse

วัตถุ

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

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

ErrorResponseDetails

วัตถุ

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

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

ItemReferenceById

วัตถุ

การอ้างอิงรายการตามออบเจ็กต์ ID

ชื่อ	พิมพ์	คำอธิบาย
itemId	string (uuid)	รหัสของสินค้า
referenceType	string: ById	ชนิดการอ้างอิงสินค้า
workspaceId	string (uuid)	ID พื้นที่ทํางานของรายการ

ItemReferenceByVariable

วัตถุ

การอ้างอิงรายการตามตัวแปร

ชื่อ	พิมพ์	คำอธิบาย
referenceType	string: ByVariable	ชนิดการอ้างอิงสินค้า
variableReference	string	สตริงการอ้างอิงตัวแปรที่ระบุไลบรารีตัวแปรและชื่อตัวแปรภายใน รูปแบบ: `$(/**/_VarLibrary_/_VarName_)` สําหรับไลบรารีตัวแปรที่ชื่อว่า VarLibrary และตัวแปรที่ชื่อว่า VarName

ItemReferenceType

การแจงนับ

ชนิดการอ้างอิงสินค้า ประเภท ItemReferenceType เพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป

ค่า	คำอธิบาย
ById	รายการถูกอ้างอิงโดย ID ของรายการนี้
ByVariable	รายการจะถูกอ้างอิงโดยตัวแปร

WorkspaceIdentity

วัตถุ

ออบเจ็กต์ข้อมูลประจําตัวของพื้นที่ทํางาน

ชื่อ	พิมพ์	คำอธิบาย
applicationId	string (uuid)	ID แอปพลิเคชัน
identityReference	ItemReference: ItemReferenceById ItemReferenceByVariable	การอ้างอิงรายการสําหรับข้อมูลประจําตัวของพื้นที่ทํางาน รองรับเฉพาะ ItemReferenceById เท่านั้น
servicePrincipalId	string (uuid)	ID โครงร่างสําคัญของบริการ