Workspaces - List Workspaces

บริการ:

Admin

เวอร์ชัน API:

v1

แสดงรายการของพื้นที่ทํางาน

Note

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

API นี้สนับสนุน การแบ่งหน้า สามารถส่งกลับบันทึกได้สูงสุด 10,000 รายการต่อคําขอ ด้วยโทเค็นแบบต่อเนื่องที่ให้ไว้ในการตอบกลับ คุณจะได้รับบันทึก 10,000 รายการถัดไป

Permissions

ผู้เรียกต้องเป็นผู้ดูแลระบบ Fabric หรือรับรองความถูกต้องโดยใช้โครงร่างสําคัญของบริการ

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

Tenant.Read.All หรือ Tenant.ReadWrite.All

Limitations

สูงสุด 200 คําขอต่อชั่วโมง

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

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

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

Interface

GET https://api.fabric.microsoft.com/v1/admin/workspaces

ด้วยพารามิเตอร์ที่เลือกได้:

GET https://api.fabric.microsoft.com/v1/admin/workspaces?type={type}&capacityId={capacityId}&name={name}&state={state}&continuationToken={continuationToken}

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

ชื่อ	ใน	จำเป็น	พิมพ์	คำอธิบาย
capacityId	query		string (uuid)	ID ความจุของพื้นที่ทํางาน
continuationToken	query		string	โทเค็นต่อเนื่อง ใช้เพื่อรับหน่วยข้อมูลถัดไปในรายการ
name	query		string	ชื่อพื้นที่ทํางาน
state	query		string	สถานะพื้นที่ทํางาน สถานะที่สนับสนุนจะใช้งานอยู่และถูกลบ
type	query		string	ประเภทพื้นที่ทํางาน ประเภทที่รองรับคือ ส่วนบุคคล พื้นที่ทํางาน พื้นที่ทํางานของผู้ดูแลระบบ

การตอบสนอง

ชื่อ	พิมพ์	คำอธิบาย
200 OK	Workspaces	การดําเนินการสําเร็จ
Other Status Codes	ErrorResponse	รหัสข้อผิดพลาดทั่วไป: BadRequest - พารามิเตอร์คิวรีเช่น workspaceType หรือ workspaceState ไม่ถูกต้อง ไม่เพียงพอ Privileges - ผู้เรียกไม่มีสิทธิ์ในการเรียกใช้ API

ตัวอย่าง

Get a list of workspaces example

Get a list of workspaces using state query parameter example

Get a list of workspaces example

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

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces

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

รหัสสถานะ:

200

{
  "workspaces": [
    {
      "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "name": "test report",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9"
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

Get a list of workspaces using state query parameter example

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

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces?state=Active

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

รหัสสถานะ:

200

{
  "workspaces": [
    {
      "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "name": "test report",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84"
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

คำจำกัดความ

ชื่อ	คำอธิบาย
ErrorRelatedResource	ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ErrorResponse	การตอบสนองข้อผิดพลาด
ErrorResponseDetails	รายละเอียดการตอบสนองข้อผิดพลาด
Workspace	Workspace.
Workspaces	รายการของพื้นที่ทํางาน
WorkspaceState	สถานะพื้นที่ทํางาน อาจมีการเพิ่มสถานะพื้นที่ทํางานเพิ่มเติมเมื่อเวลาผ่านไป
WorkspaceType	ชนิดของพื้นที่ทํางาน คุณสามารถเพิ่มชนิดพื้นที่ทํางานเพิ่มเติมเมื่อเวลาผ่านไป

ErrorRelatedResource

ออบเจ็กต์

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

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

ErrorResponse

ออบเจ็กต์

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

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

ErrorResponseDetails

ออบเจ็กต์

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

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

Workspace

ออบเจ็กต์

Workspace.

ชื่อ	พิมพ์	คำอธิบาย
capacityId	string (uuid)	ID ความจุของพื้นที่ทํางาน
domainId	string (uuid)	ID โดเมนของพื้นที่ทํางาน
id	string (uuid)	ID พื้นที่ทํางาน
name	string	ชื่อพื้นที่ทํางาน
state	WorkspaceState	สถานะพื้นที่ทํางาน
type	WorkspaceType	ประเภทพื้นที่ทํางาน

Workspaces

ออบเจ็กต์

รายการของพื้นที่ทํางาน

ชื่อ	พิมพ์	คำอธิบาย
continuationToken	string	โทเค็นสําหรับชุดผลลัพธ์ชุดถัดไป ถ้าไม่มีระเบียนเพิ่มเติม จะถูกลบออกจากการตอบสนอง
continuationUri	string	URI ของชุดงานชุดผลลัพธ์ถัดไป ถ้าไม่มีระเบียนเพิ่มเติม จะถูกลบออกจากการตอบสนอง
workspaces	Workspace[]	รายการของพื้นที่ทํางานผ้า

WorkspaceState

การแจงนับ

สถานะพื้นที่ทํางาน อาจมีการเพิ่มสถานะพื้นที่ทํางานเพิ่มเติมเมื่อเวลาผ่านไป

ค่า	คำอธิบาย
Active	พื้นที่ทํางานทํางานอยู่ พื้นที่ทํางานที่ถูกละเลยจะแสดงเป็นใช้งานอยู่
Deleted	พื้นที่ทํางานถูกลบ

WorkspaceType

การแจงนับ

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

ค่า	คำอธิบาย
Personal	โฟลเดอร์ของฉันหรือพื้นที่ทํางานของฉันที่ใช้ในการจัดการรายการของผู้ใช้
Workspace	พื้นที่ทํางานที่ใช้ในการจัดการรายการ Fabric
AdminWorkspace	ผู้ดูแลระบบตรวจสอบพื้นที่ทํางาน ประกอบด้วยรายงานของผู้ดูแลระบบ เช่น รายงานการตรวจสอบและรายงานการใช้งานและการปรับใช้