Workspaces - Create Workspace
创建新工作区。
权限
- 调用方必须有权创建 Fabric 管理员授予的工作区。 有关详细信息，请参阅： 创建工作区。
- 调用方必须具有 参与者 权限，或者必须是容量的管理员。 有关详细信息，请参阅： 容量用户权限。
- 服务主体必须具有 Fabric 管理员授予的权限。 有关详细信息，请参阅： 服务主体可以创建工作区、连接和部署管道。
所需的委派范围
Workspace.ReadWrite.All
Microsoft Entra 支持的标识
此 API 支持本节中列出的Microsoft 标识。
| 身份 | 支持 |
|---|---|
| 用户 | 是的 |
| 服务主体和托管标识 | 是的 |
接口
POST https://api.fabric.microsoft.com/v1/workspaces请求正文
| 名称 | 必需 | 类型 | 说明 |
|---|---|---|---|
| displayName | True |
string |
工作区显示名称。 |
| capacityId |
string (uuid) |
要向其分配工作区的容量的 ID。 |
|
| description |
string |
工作区说明。 |
|
| domainId |
string (uuid) |
要向其分配工作区的域的 ID。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 201 Created |
已成功创建。 标头 Location: string |
|
| Other Status Codes |
常见错误代码：
|
示例
Create a workspace example
示例请求
POST https://api.fabric.microsoft.com/v1/workspaces
{
"displayName": "New workspace"
}
示例响应
Location: https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb22287ff{
"id": "cfafbeb1-8037-4d0c-896e-a46fb22287ff",
"displayName": "New workspace",
"description": "",
"type": "Workspace"
}定义
| 名称 | 说明 |
|---|---|
|
Create |
创建工作区请求有效负载。 |
|
Error |
与错误相关的资源详细信息对象。 |
|
Error |
错误响应。 |
|
Error |
错误响应详细信息。 |
| Workspace |
工作区对象。 |
|
Workspace |
工作区类型。 可能会随着时间的推移添加其他工作区类型。 |
CreateWorkspaceRequest
创建工作区请求有效负载。
| 名称 | 类型 | 说明 |
|---|---|---|
| capacityId |
string (uuid) |
要向其分配工作区的容量的 ID。 |
| description |
string |
工作区说明。 |
| displayName |
string |
工作区显示名称。 |
| domainId |
string (uuid) |
要向其分配工作区的域的 ID。 |
ErrorRelatedResource
与错误相关的资源详细信息对象。
| 名称 | 类型 | 说明 |
|---|---|---|
| resourceId |
string |
错误中涉及的资源 ID。 |
| resourceType |
string |
错误中涉及的资源的类型。 |
ErrorResponse
错误响应。
| 名称 | 类型 | 说明 |
|---|---|---|
| errorCode |
string |
提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。 |
| message |
string |
错误的人工可读表示形式。 |
| moreDetails |
其他错误详细信息的列表。 |
|
| relatedResource |
与错误相关的资源详细信息。 |
|
| requestId |
string |
与错误关联的请求的 ID。 |
ErrorResponseDetails
错误响应详细信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| errorCode |
string |
提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。 |
| message |
string |
错误的人工可读表示形式。 |
| relatedResource |
与错误相关的资源详细信息。 |
Workspace
工作区对象。
| 名称 | 类型 | 说明 |
|---|---|---|
| apiEndpoint |
string (uri) |
表示特定于工作区的 API 终结点的 HTTP URL。 当用户启用 preferWorkspaceSpecificEndpoints 时，将返回此终结点值。 它允许通过专用链接访问 API。 |
| capacityId |
string (uuid) |
工作区分配给的容量的 ID。 |
| description |
string |
工作区说明。 |
| displayName |
string |
工作区显示名称。 |
| domainId |
string (uuid) |
工作区分配到的域的 ID。 |
| id |
string (uuid) |
工作区 ID。 |
| type |
工作区类型。 |
WorkspaceType
工作区类型。 可能会随着时间的推移添加其他工作区类型。
| 值 | 说明 |
|---|---|
| Personal |
我的文件夹或用于管理用户项的工作区。 |
| Workspace |
用于管理 Fabric 项的工作区。 |
| AdminWorkspace |
管理员监视工作区。 包含管理员报告，例如审核报告以及使用情况和采用报告。 |