Workspaces - List Workspaces

บริการ:: Core

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

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

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

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

ขีดจํากัดการควบคุม

ประเภทขีดจํากัด	ค่า
โควตาแบบรวมสําหรับแพลตฟอร์ม API	โทร 200 ครั้ง/นาที
ขีดจํากัด API	โทร 200 ครั้ง/นาที

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

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

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

อิน เทอร์ เฟซ

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

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

GET https://api.fabric.microsoft.com/v1/workspaces?roles={roles}&continuationToken={continuationToken}&preferWorkspaceSpecificEndpoints={preferWorkspaceSpecificEndpoints}

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

ชื่อ	ใน	พิมพ์	คำอธิบาย
continuationToken	query	string	โทเค็นสําหรับการเรียกใช้หน้าถัดไปของผลลัพธ์
preferWorkspaceSpecificEndpoints	query	boolean	การตั้งค่าที่ควบคุมว่าจะรวมจุดสิ้นสุด API เฉพาะพื้นที่ทํางานสําหรับแต่ละพื้นที่ทํางานหรือไม่ True - รวมจุดสิ้นสุด API เฉพาะพื้นที่ทํางาน เท็จ - ไม่รวมจุดสิ้นสุด API เฉพาะพื้นที่ทํางาน
roles	query	string	รายการของบทบาท แยกค่าโดยใช้เครื่องหมายจุลภาค ถ้าไม่มี พื้นที่ทํางานทั้งหมดจะถูกส่งกลับ

การตอบสนอง

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

200 OK

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

Workspaces

คําขอเสร็จสมบูรณ์

429 Too Many Requests

ErrorResponse

เกินขีดจํากัดอัตราการบริการ เซิร์ฟเวอร์จะส่งกลับ Retry-After ส่วนหัวที่ระบุ ภายในไม่กี่วินาที ระยะเวลาที่ไคลเอ็นต์ต้องรอก่อนที่จะส่งคําขอเพิ่มเติม

ส่วนหัว

Retry-After: integer

Other Status Codes

ErrorResponse

รหัสข้อผิดพลาดทั่วไป:

InvalidParameter - บทบาทพื้นที่ทํางานไม่ถูกต้อง
UnknownError - เกิดข้อผิดพลาด

ตัวอย่าง

List workspaces example

List workspaces with continuation example

List workspaces with preferWorkspaceSpecificEndpoints example

List workspaces with roles filter example

List workspaces example

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

HTTP

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

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

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

{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "My workspace",
      "description": "",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Marketing",
      "description": "A  workspace used by the marketing team",
      "type": "Workspace",
      "tags": [
        {
          "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
          "displayName": "Marketing"
        }
      ]
    },
    {
      "id": "f2d70dc6-8f3e-4f2c-b00e-e2d336d7d711",
      "displayName": "Finance",
      "description": "A workspace used by the finance team",
      "type": "Workspace",
      "capacityId": "171018af-1531-4e61-942a-74f024b7f9fd",
      "domainId": "7c889f28-999b-4945-840d-54da3e3b5a29",
      "capacityRegion": "East US",
      "tags": [
        {
          "id": "9b8c7d6e-5f4a-3b2c-1d0e-9f8a7b6c5d4e",
          "displayName": "Finance"
        },
        {
          "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
          "displayName": "Marketing"
        }
      ]
    }
  ]
}

List workspaces with continuation example

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

HTTP

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

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

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

{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "My workspace",
      "description": "",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Marketing",
      "description": "A  workspace used by the marketing team",
      "type": "Workspace"
    },
    {
      "id": "f2d70dc6-8f3e-4f2c-b00e-e2d336d7d711",
      "displayName": "Finance",
      "description": "A workspace used by the finance team",
      "type": "Workspace",
      "capacityId": "171018af-1531-4e61-942a-74f024b7f9fd",
      "capacityRegion": "East US"
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces?continuationToken=LDEsMTAwMDAwLDA%3D"
}

List workspaces with preferWorkspaceSpecificEndpoints example

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

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces?preferWorkspaceSpecificEndpoints=True

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

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

{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Alice's Workspace",
      "description": "A workspace for Alice",
      "type": "Workspace",
      "apiEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.w.api.fabric.microsoft.com"
    },
    {
      "id": "0c02a0cd-71bc-410f-aa05-5a7bc98765f7",
      "displayName": "Bob's Workspace",
      "description": "A workspace for Bob",
      "type": "Workspace",
      "apiEndpoint": "https://0c02a0cd71bc410faa055a7bc98765f7.z0c.w.api.fabric.microsoft.com"
    }
  ]
}

List workspaces with roles filter example

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

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces?roles=Admin,Member,Contributor,Viewer

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

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

{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "Admins workspace",
      "description": "A workspace for admins",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Members workspace",
      "description": "A workspace for members",
      "type": "Workspace"
    },
    {
      "id": "0c02a0cd-71bc-410f-aa05-5a7bc98765f7",
      "displayName": "Contributors workspace",
      "description": "A workspace for contributors",
      "type": "Workspace"
    },
    {
      "id": "99d58687-8903-4dbd-8a78-40f95dca7177",
      "displayName": "Viewers workspace",
      "description": "A workspace for viewers",
      "type": "Workspace"
    }
  ]
}

คำจำกัดความ

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

CapacityRegion

การแจงนับ

ภูมิภาคของความจุที่เชื่อมโยงกับพื้นที่ทํางานนี้ อาจมีการเพิ่มค่าภูมิภาคความจุเพิ่มเติมเมื่อเวลาผ่านไป

ค่า	คำอธิบาย
Australia East	ภูมิภาคออสเตรเลียตะวันออก
Australia Southeast	ภูมิภาคตะวันออกเฉียงใต้ของออสเตรเลีย
Brazil South	บราซิลใต้ภูมิภาค
Brazil Southeast	ภูมิภาคตะวันออกเฉียงใต้ของบราซิล
Canada Central	แคนาดาตอนกลางของภูมิภาค
Canada East	แคนาดาตะวันออก
Central India	ภูมิภาคอินเดียตอนกลาง
Central US	ภูมิภาคของสหรัฐอเมริกาตอนกลาง
Central US EUAP	ภูมิภาค EUAP ของสหรัฐอเมริกาตอนกลาง
East Asia	ภูมิภาคเอเชียตะวันออก
East US	ภูมิภาคสหรัฐอเมริกาตะวันออก
East US 2	ภูมิภาคสหรัฐอเมริกาฝั่งตะวันออก 2
France Central	ภูมิภาคส่วนกลางของฝรั่งเศส
France South	ภูมิภาคฝรั่งเศสตอนใต้
Germany Central	ภูมิภาคเยอรมนีตอนกลาง
Germany Northeast	เยอรมนีตะวันออกเฉียงเหนือ
Israel Central	อิสราเอลตอนกลาง
Italy North	ภูมิภาคอิตาลีเหนือ
Japan East	ญี่ปุ่นตะวันออก
Japan West	ญี่ปุ่นตะวันตก
Korea Central	เกาหลีตอนกลางภูมิภาค
Korea South	เกาหลีตอนใต้
Mexico Central	ภูมิภาคเม็กซิโกตอนกลาง
North Central US	ภูมิภาคสหรัฐอเมริกาตอนกลางทางเหนือ
North Europe	ภูมิภาคยุโรปเหนือ
Norway East	ภูมิภาคตะวันออกของนอร์เวย์
Norway West	ภูมิภาคนอร์เวย์ตะวันตก
Poland Central	ภูมิภาคตอนกลางของโปแลนด์
South Africa North	แอฟริกาใต้ในภูมิภาคเหนือ
South Africa West	ภูมิภาคแอฟริกาตะวันตกเฉียงใต้
South Central US	ภูมิภาคสหรัฐอเมริกาตอนกลางทางใต้
South India	ภูมิภาคอินเดียใต้
Southeast Asia	ภูมิภาคเอเชียตะวันออกเฉียงใต้
Spain Central	ภูมิภาคสเปนตอนกลาง
Sweden Central	ภูมิภาคกลางของสวีเดน
Switzerland North	สวิตเซอร์แลนด์เหนือ
Switzerland West	ภูมิภาคสวิตเซอร์แลนด์ตะวันตก
West Europe	ภูมิภาคยุโรปตะวันตก
West India	ภูมิภาคอินเดียตะวันตก
West US	ภูมิภาคสหรัฐอเมริกาตะวันตก
West US 2	US 2 ภูมิภาคตะวันตก
West US 3	US 3 ภูมิภาคตะวันตก
West Central US	ภูมิภาคสหรัฐอเมริกาตอนกลางทางตะวันตก
UAE Central	ภูมิภาคกลางของ UAE
UAE North	ภูมิภาค UAE North
Qatar Central	ภูมิภาคกาตาร์ตอนกลาง
Germany West Central	เยอรมนีตอนกลางทางตะวันตก
Germany North	ภูมิภาคเยอรมนีเหนือ
UK South	ภูมิภาคทางใต้ของสหราชอาณาจักร
UK West	ภูมิภาคตะวันตกของสหราชอาณาจักร
China North	จีนเหนือ
China East	ภูมิภาคตะวันออกของจีน
China East 2	จีนตะวันออก 2 ภูมิภาค
China East 3	จีนตะวันออก 3 ภูมิภาค
China North 2	จีนเหนือ 2 ภูมิภาค
China North 3	จีนเหนือ 3 ภูมิภาค

ErrorRelatedResource

วัตถุ

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

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

ErrorResponse

วัตถุ

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

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

ErrorResponseDetails

วัตถุ

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

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

Workspace

วัตถุ

ออบเจ็กต์พื้นที่ทํางาน

ชื่อ	พิมพ์	คำอธิบาย
apiEndpoint	string (uri)	URL HTTP ที่แสดงถึงจุดสิ้นสุด API เฉพาะสําหรับพื้นที่ทํางาน ค่าจุดสิ้นสุดนี้จะถูกส่งกลับเมื่อผู้ใช้เปิดใช้งานมากกว่า WorkspaceSpecificEndpoints อนุญาตให้เข้าถึง API ผ่านลิงก์ส่วนตัว
capacityId	string (uuid)	ID ของความจุที่มีการกําหนดพื้นที่ทํางานให้กับพื้นที่ทํางาน
capacityRegion	CapacityRegion	ภูมิภาคของความจุที่เชื่อมโยงกับพื้นที่ทํางานนี้
description	string	คําอธิบายพื้นที่ทํางาน
displayName	string	ชื่อที่แสดงของพื้นที่ทํางาน
domainId	string (uuid)	ID ของโดเมนที่มีการกําหนดพื้นที่ทํางานให้
id	string (uuid)	ID พื้นที่ทํางาน
tags	WorkspaceAppliedTag[]	รายการของแท็กที่ใช้
type	WorkspaceType	ประเภทพื้นที่ทํางาน

WorkspaceAppliedTag

วัตถุ

แสดงแท็กที่ถูกนําไปใช้

ชื่อ	พิมพ์	คำอธิบาย
displayName	string	ชื่อของแท็ก
id	string (uuid)	ID แท็ก

Workspaces

วัตถุ

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

WorkspaceType

การแจงนับ

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

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