Items - Create Item

服務:

Core

API 版本:

v1

在指定的工作區中建立專案。
此 API 支援數個項目類型，請在 專案管理概觀中找到支援的專案類型，。 您可以使用 取得項目定義 API 來取得項目定義。

此 API 支援 長時間執行的作業 （LRO）。

權限

呼叫者必須具有 參與者 或更高的工作區角色。

必要的委派範圍

針對專案 API，請使用下列範圍類型：

• 泛型範圍：Item.ReadWrite.All
• 特定範圍：itemType。ReadWrite.All （例如：Notebook.ReadWrite.All）

如需範圍的詳細資訊，請參閱 範圍一文。

局限性

• 若要建立非 PowerBI Fabric 專案，工作區必須位於支援的 Fabric 容量上。 如需詳細資訊，請參閱 Microsoft 網狀架構授權類型。
• 若要建立PowerBI專案，用戶必須擁有適當的授權。 如需詳細資訊，請參閱 Microsoft 網狀架構授權類型。
• 建立專案時，請使用 creationPayload 或 definition，但不同時使用兩者。

Microsoft Entra 支援的身分識別

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

身份	支援
使用者	是的
服務主體 和 受控識別	支援呼叫中的項目類型時。 檢查您要呼叫的專案類型對應的 API，以查看您的呼叫是否受到支援。 例如，支援語意模型。

介面

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items

URI 參數

名稱	位於	必要	類型	Description
workspaceId	path	True	string uuid	工作區標識碼。

要求本文

名稱	必要	類型	Description
displayName	True	string	項目顯示名稱。 顯示名稱必須依照項目類型遵循命名規則。
type	True	ItemType	項目類型。
creationPayload		object	一組用來建立項目的屬性。 相關類型的 [建立專案 ] 頁面 指出是否支援 creationPayload，並列出項目的屬性。 使用 creationPayload 或 definition。 您無法同時使用這兩者。
definition		ItemDefinition	項目定義。 相關類型的 [建立專案 ] 頁面 指出是否支持定義，並詳細說明其結構。 使用 definition 或 creationPayload。 您無法同時使用這兩者。
description		string	專案描述。 長度上限為 256 個字元。

回應

名稱	類型	Description
201 Created	Item	已成功建立
202 Accepted		要求已接受，正在進行專案布建 標題 Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	常見的錯誤碼： InvalidItemType - 項目類型無效。 ItemDisplayNameAlreadyInUse - 已使用項目顯示名稱。 CorruptedPayload - 提供的承載已損毀

範例

Create an item example

範例要求

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items

{
  "displayName": "Item 1",
  "type": "Lakehouse"
}

範例回覆

狀態碼:

201

{
  "displayName": "Item 1",
  "description": "",
  "type": "Lakehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

狀態碼:

202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

定義

名稱	Description
CreateItemRequest	建立專案要求承載。
ErrorRelatedResource	錯誤相關的資源詳細資料物件。
ErrorResponse	錯誤回應。
ErrorResponseDetails	錯誤回應詳細數據。
Item	項目物件。
ItemDefinition	項目定義物件。
ItemDefinitionPart	專案定義部分物件。
ItemType	專案的型別。 可能會隨著時間新增其他項目類型。
PayloadType	定義元件承載的類型。 可能會隨著時間新增其他承載類型。

CreateItemRequest

Object

建立專案要求承載。

名稱	類型	Description
creationPayload	object	一組用來建立項目的屬性。 相關類型的 [建立專案 ] 頁面 指出是否支援 creationPayload，並列出項目的屬性。 使用 creationPayload 或 definition。 您無法同時使用這兩者。
definition	ItemDefinition	項目定義。 相關類型的 [建立專案 ] 頁面 指出是否支持定義，並詳細說明其結構。 使用 definition 或 creationPayload。 您無法同時使用這兩者。
description	string	專案描述。 長度上限為 256 個字元。
displayName	string	項目顯示名稱。 顯示名稱必須依照項目類型遵循命名規則。
type	ItemType	項目類型。

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	錯誤相關的資源詳細數據。

Item

Object

項目物件。

名稱	類型	Description
description	string	專案描述。
displayName	string	項目顯示名稱。
id	string uuid	項目標識碼。
type	ItemType	項目類型。
workspaceId	string uuid	工作區標識碼。

ItemDefinition

Object

項目定義物件。

名稱	類型	Description
format	string	項目定義的格式。
parts	ItemDefinitionPart[]	定義元件的清單。

ItemDefinitionPart

Object

專案定義部分物件。

名稱	類型	Description
path	string	專案元件路徑。
payload	string	專案元件承載。
payloadType	PayloadType	承載類型。

ItemType

Enumeration

專案的型別。 可能會隨著時間新增其他項目類型。

值	Description
Dashboard	PowerBI 儀錶板。
DataPipeline	數據管線。
Datamart	PowerBI datamart。
Environment	環境。
Eventhouse	事件屋。
Eventstream	eventstream。
GraphQLApi	GraphQL 專案的 API。
KQLDashboard	KQL 儀錶板。
KQLDatabase	KQL 資料庫。
KQLQueryset	KQL 查詢集。
Lakehouse	湖屋
MLExperiment	機器學習實驗。
MLModel	機器學習模型。
MirroredDatabase	鏡像資料庫。
MirroredWarehouse	鏡像倉儲。
MountedDataFactory	MountedDataFactory。
Notebook	筆記本。
PaginatedReport	PowerBI 編頁報表。
Reflex	反射。
Report	PowerBI 報表。
SQLDatabase	SQLDatabase。
SQLEndpoint	SQL 端點。
SemanticModel	PowerBI 語意模型。
SparkJobDefinition	Spark 作業定義。
Warehouse	倉儲。

PayloadType

Enumeration

定義元件承載的類型。 可能會隨著時間新增其他承載類型。

值	Description
InlineBase64	內嵌基底 64。