通过

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 - 发生错误。

示例

Get a workspace example
Get a workspace with preferWorkspaceSpecificEndpoints example

Get a workspace example

示例请求

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

示例请求

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

美国西部 2 区域
West US 3

美国西部 3 区域
West Central US

美国中西部区域
UAE Central

阿联酋中部区域
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

Object

与错误相关的资源详细信息对象。

名称 类型 说明
resourceId

string

错误中涉及的资源 ID。
resourceType

string

错误中涉及的资源的类型。

ErrorResponse

Object

错误响应。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
moreDetails

ErrorResponseDetails[]

其他错误详细信息的列表。
relatedResource

ErrorRelatedResource

与错误相关的资源详细信息。
requestId

string

与错误关联的请求的 ID。

ErrorResponseDetails

Object

错误响应详细信息。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
relatedResource

ErrorRelatedResource

与错误相关的资源详细信息。

OneLakeEndpoints

Object

与此工作区关联的 OneLake API 终结点。

名称 类型 说明
blobEndpoint

string

可用于 Blob API作的 OneLake API 终结点。 默认情况下，这是特定于区域的终结点。 如果用户启用 preferWorkspaceSpecificEndpoints 或工作区已禁用公共访问权限，则会提供特定于工作区的终结点，以允许通过专用链接进行访问。
dfsEndpoint

string

可用于分布式文件系统（DFS）或 ADLSgen2 文件系统 API作的 OneLake API 终结点。 默认情况下，这是特定于区域的终结点。 如果用户启用 preferWorkspaceSpecificEndpoints 或工作区已禁用公共访问权限，则会提供特定于工作区的终结点，以允许通过专用链接进行访问。

WorkspaceIdentity

Object

工作区标识对象。

名称 类型 说明
applicationId

string

应用程序 ID。
servicePrincipalId

string

服务主体 ID。

WorkspaceInfo

Object

工作区对象。

名称 类型 说明
apiEndpoint

string (uri)

表示特定于工作区的 API 终结点的 HTTP URL。 当用户启用 preferWorkspaceSpecificEndpoints 时，将返回此终结点值。 它允许通过专用链接访问 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

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