通过

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

此操作成功。
429 Too Many Requests

ErrorResponse

超出服务速率限制。 服务器返回一个 Retry-After 标头，指示客户端在发送其他请求之前必须等待的时间（以秒为单位）。

标头

Retry-After: integer
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
}

定义

名称 说明
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 (uuid)

与错误关联的请求的 ID。

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

管理员监视工作区。 包含管理员报告，例如审核报告以及使用情况和采用报告。