Workspaces - Get Workspace

บริการ:: Core

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

ส่งกลับข้อมูลพื้นที่ทํางานที่ระบุ

สิทธิ์

ผู้เรียกต้องมีบทบาท ของผู้ชม หรือสูงกว่าพื้นที่ทํางาน

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

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

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

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

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

อินเตอร์เฟซ

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

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

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

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

ชื่อ	ใน	จำเป็น	พิมพ์	คำอธิบาย
workspaceId	path	True	string (uuid)	ID พื้นที่ทํางาน
preferWorkspaceSpecificEndpoints	query		boolean	การตั้งค่าที่ควบคุมว่าจะรวมจุดสิ้นสุดสาธารณะเฉพาะของพื้นที่ทํางานหรือทั่วไปสําหรับ API และการเข้าถึง OneLake True - รวมจุดสิ้นสุดเฉพาะของพื้นที่ทํางานสําหรับการเข้าถึง API และ OneLake, False - รวมจุดสิ้นสุดสาธารณะทั่วไปสําหรับการเข้าถึง OneLake

การตอบสนอง

ชื่อ	พิมพ์	คำอธิบาย
200 OK	WorkspaceInfo	คําขอเสร็จสมบูรณ์
Other Status Codes	ErrorResponse	รหัสข้อผิดพลาดทั่วไป: UnknownError - เกิดข้อผิดพลาด

ชื่อ

พิมพ์

คำอธิบาย

200 OK

WorkspaceInfo

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

Other Status Codes

ErrorResponse

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

UnknownError - เกิดข้อผิดพลาด

ตัวอย่าง

Get a workspace example

Get a workspace with preferWorkspaceSpecificEndpoints example

Get a workspace example

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

HTTP

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

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

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

{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
  "displayName": "New workspace",
  "description": "New workspace description",
  "type": "Workspace",
  "domainId": "9ce364e0-8e9d-4605-887a-b599b3e8b123",
  "capacityId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
  "capacityAssignmentProgress": "Completed",
  "workspaceIdentity": {
    "applicationId": "00a4a8f9-78d3-41b3-b87a-6ae5271c8d0d",
    "servicePrincipalId": "5ba4ae58-d402-45c6-a848-0253e834fd78"
  },
  "capacityRegion": "East US",
  "oneLakeEndpoints": {
    "blobEndpoint": "https://eastus-onelake.blob.fabric.microsoft.com",
    "dfsEndpoint": "https://eastus-onelake.dfs.fabric.microsoft.com"
  }
}

Get a workspace with preferWorkspaceSpecificEndpoints example

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

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227?preferWorkspaceSpecificEndpoints=True

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

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

{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
  "displayName": "New workspace",
  "description": "New workspace description",
  "type": "Workspace",
  "capacityId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
  "capacityAssignmentProgress": "Completed",
  "workspaceIdentity": {
    "applicationId": "00a4a8f9-78d3-41b3-b87a-6ae5271c8d0d",
    "servicePrincipalId": "5ba4ae58-d402-45c6-a848-0253e834fd78"
  },
  "capacityRegion": "East US",
  "oneLakeEndpoints": {
    "blobEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.blob.fabric.microsoft.com",
    "dfsEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.dfs.fabric.microsoft.com"
  },
  "apiEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.w.api.fabric.microsoft.com"
}

คำจำกัดความ

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

CapacityAssignmentProgress

การแจงนับ

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

ค่า	คำอธิบาย
Completed	การดําเนินการกําหนดความจุครั้งล่าสุดเสร็จสมบูรณ์
Failed	การดําเนินการกําหนดความจุพบข้อผิดพลาดหรือความล้มเหลว และไม่สามารถดําเนินการให้เสร็จสมบูรณ์ได้
InProgress	การดําเนินการกําหนดความจุกําลังทํางานอยู่ในขณะนี้และยังไม่เสร็จสมบูรณ์

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

ErrorResponseDetails

ออบเจ็กต์

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

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

OneLakeEndpoints

ออบเจ็กต์

จุดสิ้นสุด OneLake API ที่เชื่อมโยงกับพื้นที่ทํางานนี้

ชื่อ	พิมพ์	คำอธิบาย
blobEndpoint	string	จุดสิ้นสุด OneLake API ที่พร้อมใช้งานสําหรับการดําเนินการ Blob API ตามค่าเริ่มต้น นี่คือจุดสิ้นสุดเฉพาะของภูมิภาค หากผู้ใช้เปิดใช้งาน preferWorkspaceSpecificEndpoints หรือพื้นที่ทํางานมีการปิดใช้งานการเข้าถึงสาธารณะ จุดสิ้นสุดเฉพาะพื้นที่ทํางานจะมีไว้เพื่ออนุญาตให้เข้าถึงผ่านลิงก์ส่วนตัว
dfsEndpoint	string	จุดสิ้นสุด OneLake API พร้อมใช้งานสําหรับการดําเนินการ API ระบบไฟล์แบบกระจาย (DFS) หรือ ADLSgen2 filesystem API ตามค่าเริ่มต้น นี่คือจุดสิ้นสุดเฉพาะของภูมิภาค หากผู้ใช้เปิดใช้งาน preferWorkspaceSpecificEndpoints หรือพื้นที่ทํางานมีการปิดใช้งานการเข้าถึงสาธารณะ จุดสิ้นสุดเฉพาะพื้นที่ทํางานจะมีไว้เพื่ออนุญาตให้เข้าถึงผ่านลิงก์ส่วนตัว

WorkspaceIdentity

ออบเจ็กต์

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

ชื่อ	พิมพ์	คำอธิบาย
applicationId	string	ID แอปพลิเคชัน
servicePrincipalId	string	ID โครงร่างสําคัญของบริการ

WorkspaceInfo

ออบเจ็กต์

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

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

WorkspaceType

การแจงนับ

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

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

แชร์ผ่าน

Workspaces - Get Workspace

สิทธิ์

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

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

อินเตอร์เฟซ

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

การตอบสนอง

ตัวอย่าง

Get a workspace example

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

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

Get a workspace with preferWorkspaceSpecificEndpoints example

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

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

คำจำกัดความ

CapacityAssignmentProgress

CapacityRegion

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

OneLakeEndpoints

WorkspaceIdentity

WorkspaceInfo

WorkspaceType