Workspaces - Create Workspace

服務:

Core

API 版本:

v1

建立新工作區。

權限

• 呼叫端必須具有許可權，才能建立 Fabric 系統管理員授與的工作區。 如需詳細資訊，請參閱： 建立工作區。
• 呼叫端必須具有 參與者 許可權，或是容量上的系統管理員。 如需詳細資訊，請參閱： 容量用戶權力。
• 服務主體必須具有網狀架構系統管理員授與的許可權。 如需詳細資訊，請參閱： 服務主體可以建立工作區、連線和部署管線。

必要的委派範圍

Workspace.ReadWrite.All

節流限制

限制類型	Value
平台 API 統一配額	每分鐘500通電話
API 限制	每分鐘200通電話

Microsoft Entra 支援的身份識別

此 API 支援本節中列出的Microsoft 身分識別。

身份	支援
使用者	是的
服務主體 和 受控識別	是的

介面

POST https://api.fabric.microsoft.com/v1/workspaces

要求本文

名稱	必要	類型	Description
displayName	True	string	工作區顯示名稱。 顯示名稱不能包含超過 256 個字元。 只允許未使用的工作區名稱。 「系統管理員監視」是保留的工作區名稱。
capacityId		string (uuid)	要指派工作區之容量的標識碼。
description		string	工作區描述。 描述不能包含超過 4000 個字元。
domainId		string (uuid)	要指派工作區的網域識別碼。

回覆

名稱	類型	Description
201 Created	Workspace	已成功建立。 標題 Location: string
429 Too Many Requests	ErrorResponse	服務費率上限被超標。 伺服器會回傳一個 Retry-After 標頭，以秒數表示客戶端在發送額外請求前必須等待多久。 標題 Retry-After: integer
Other Status Codes	ErrorResponse	常見的錯誤碼： DomainNotFound - 找不到提供的網域 InsufficientPermissionsToDomain - 網域的使用者權限不足以執行作業 UnknownError - 發生錯誤。

範例

Create a workspace example

範例要求

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces

{
  "displayName": "New workspace"
}

範例回覆

狀態碼:

201

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",
  "capacityRegion": "West US"
}

定義

名稱	Description
CapacityRegion	與此工作區相關聯的容量區域。 可能會隨著時間新增額外的容量區域值。
CreateWorkspaceRequest	建立工作區要求承載。
ErrorParameter	一個結構化參數，提供關於錯誤的額外機器可讀上下文。
ErrorRelatedResource	錯誤相關的資源詳細資料物件。
ErrorResponse	錯誤回應。
ErrorResponseDetails	錯誤回應詳細數據。
Workspace	工作區物件。
WorkspaceAppliedTag	代表已套用的標籤。
WorkspaceType	工作區類型。 可能會隨著時間新增其他工作區類型。

CapacityRegion

列舉型別

與此工作區相關聯的容量區域。 可能會隨著時間新增額外的容量區域值。

值	Description
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 區域

CreateWorkspaceRequest

Object

建立工作區要求承載。

名稱	類型	Description
capacityId	string (uuid)	要指派工作區之容量的標識碼。
description	string	工作區描述。 描述不能包含超過 4000 個字元。
displayName	string	工作區顯示名稱。 顯示名稱不能包含超過 256 個字元。 只允許未使用的工作區名稱。 「系統管理員監視」是保留的工作區名稱。
domainId	string (uuid)	要指派工作區的網域識別碼。

ErrorParameter

Object

一個結構化參數，提供關於錯誤的額外機器可讀上下文。

名稱	類型	Description
message	string	一個人類可讀的參數意義描述。
name	string	參數識別碼。
value	string	這是參數值。

ErrorRelatedResource

Object

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

名稱	類型	Description
resourceId	string	發生錯誤的資源識別碼。
resourceType	string	發生錯誤的資源類型。

ErrorResponse

Object

錯誤回應。

名稱	類型	Description
errorCode	string	提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
isRetriable	boolean	若屬實，請求可重新嘗試。 如果有延遲，請使用 Retry-After 回應標頭來判斷延遲。
message	string	錯誤的人類可讀取表示法。
moreDetails	ErrorResponseDetails[]	其他錯誤詳細數據的清單。
parameters	ErrorParameter[]	結構化參數提供更多機器可讀的錯誤上下文。
relatedResource	ErrorRelatedResource	錯誤相關的資源詳細數據。
requestId	string (uuid)	與錯誤相關聯的要求標識碼。

ErrorResponseDetails

Object

錯誤回應詳細數據。

名稱	類型	Description
errorCode	string	提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message	string	錯誤的人類可讀取表示法。
parameters	ErrorParameter[]	結構化參數提供更多機器可讀的錯誤上下文。
relatedResource	ErrorRelatedResource	錯誤相關的資源詳細數據。

Workspace

Object

工作區物件。

名稱	類型	Description
apiEndpoint	string (uri)	HTTP URL，代表工作區特定的 API 端點。 當使用者啟用 preferWorkspaceSpecificEndpoints 時，會傳回此端點值。 它允許透過私人連結進行 API 存取。
capacityId	string (uuid)	指派工作區之容量的標識碼。
capacityRegion	CapacityRegion	與此工作區相關聯的容量區域。
description	string	工作區描述。
displayName	string	工作區顯示名稱。
domainId	string (uuid)	工作區指派至之網域的識別碼。
id	string (uuid)	工作區識別碼。
tags	WorkspaceAppliedTag[]	已套用標籤的清單。
type	WorkspaceType	工作區類型。

WorkspaceAppliedTag

Object

代表已套用的標籤。

名稱	類型	Description
displayName	string	標籤的名稱。
id	string (uuid)	標記標識碼。

WorkspaceType

列舉型別

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

值	Description
Personal	我的資料夾或我的工作區，用來管理用戶專案。
Workspace	用來管理 Fabric 專案的工作區。
AdminWorkspace	系統管理員監視工作區。 包含系統管理員報告，例如稽核報告和使用量和採用報告。