共用方式為

Workspaces - List Workspaces

服務:
Admin
API 版本:
v1

傳回工作區清單。

Note

此 API 是預覽版的一部分，僅供評估和開發之用。 它可能會根據意見反應而變更，不建議用於生產環境。

此 API 支援 分頁。 每個要求最多可以傳回 10,000 筆記錄。 透過回應中提供的連續令牌，您可以取得接下來的 10,000 筆記錄。

Permissions

呼叫端必須是網狀架構系統管理員，或使用服務主體進行驗證。

必要的委派範圍

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 參數

名稱 位於 必要 類型 Description
capacityId
 query

string (uuid)

工作區的容量標識碼。
continuationToken
 query

string

接續令牌。 用來取得清單中的下一個專案。
name
 query

string

工作區名稱。
state
 query

string

工作區狀態。 支援的狀態為作用中且已刪除。
type
 query

string

工作區類型。 支持的類型為個人、工作區、adminworkspace。

回應

名稱 類型 Description
200 OK

Workspaces

作業成功。
Other Status Codes

ErrorResponse

常見的錯誤碼：

  • BadRequest - 查詢參數，例如 workspaceType 或 workspaceState 無效。

  • InsufficientPrivileges - 呼叫端沒有呼叫 API 的許可權。

範例

Get a list of workspaces example
Get a list of workspaces using state query parameter example

Get a list of workspaces example

範例要求

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

範例要求

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
}

定義

名稱 Description
ErrorRelatedResource

錯誤相關的資源詳細資料物件。
ErrorResponse

錯誤回應。
ErrorResponseDetails

錯誤回應詳細數據。
Workspace

Workspace.
Workspaces

工作區清單。
WorkspaceState

工作區狀態。 可能會隨著時間新增其他工作區狀態。
WorkspaceType

工作區類型。 可能會隨著時間新增其他工作區類型。

ErrorRelatedResource

Object

錯誤相關的資源詳細資料物件。

名稱 類型 Description
resourceId

string

發生錯誤的資源識別碼。
resourceType

string

發生錯誤的資源類型。

ErrorResponse

Object

錯誤回應。

名稱 類型 Description
errorCode

string

提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message

string

錯誤的人類可讀取表示法。
moreDetails

ErrorResponseDetails[]

其他錯誤詳細數據的清單。
relatedResource

ErrorRelatedResource

錯誤相關的資源詳細數據。
requestId

string

與錯誤相關聯的要求標識碼。

ErrorResponseDetails

Object

錯誤回應詳細數據。

名稱 類型 Description
errorCode

string

提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message

string

錯誤的人類可讀取表示法。
relatedResource

ErrorRelatedResource

錯誤相關的資源詳細數據。

Workspace

Object

Workspace.

名稱 類型 Description
capacityId

string (uuid)

工作區的容量標識碼。
domainId

string (uuid)

工作區的網域 ID。
id

string (uuid)

工作區識別碼。
name

string

工作區名稱。
state

WorkspaceState

工作區狀態。
type

WorkspaceType

工作區類型。

Workspaces

Object

工作區清單。

名稱 類型 Description
continuationToken

string

下一個結果集批次的令牌。 如果沒有其他記錄，則會從回應中移除。
continuationUri

string

下一個結果集批次的 URI。 如果沒有其他記錄，則會從回應中移除。
workspaces

Workspace[]

網狀架構工作區的清單。

WorkspaceState

列舉型別

工作區狀態。 可能會隨著時間新增其他工作區狀態。

值 Description
Active

工作區為作用中。 孤立的工作區會顯示為作用中。
Deleted

工作區已刪除。

WorkspaceType

列舉型別

工作區類型。 可能會隨著時間新增其他工作區類型。

值 Description
Personal

我的資料夾或我的工作區，用來管理用戶專案。
Workspace

用來管理 Fabric 專案的工作區。
AdminWorkspace

系統管理員監視工作區。 包含系統管理員報告，例如稽核報告和使用量和採用報告。