共用方式為


Items - Update Item

更新指定項目的屬性。
此 API 支援數個項目類型、在 專案管理概觀中找到支援的項目類型和其定義結構的相關信息,

權限

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

必要的委派範圍

針對專案 API,請使用下列範圍類型:

  • 泛型範圍:Item.ReadWrite.All
  • 特定範圍:itemType。ReadWrite.All (例如:Notebook.ReadWrite.All)

如需範圍的詳細資訊,請參閱:範圍一文

Microsoft Entra 支援的身分識別

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

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

介面

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

URI 參數

名稱 位於 必要 類型 Description
itemId
path True

string

uuid

項目標識碼。

workspaceId
path True

string

uuid

工作區標識碼。

要求本文

名稱 類型 Description
description

string

專案描述。 長度上限為 256 個字元。

displayName

string

項目顯示名稱。 顯示名稱必須依照項目類型遵循命名規則。

回應

名稱 類型 Description
200 OK

Item

要求成功完成。

Other Status Codes

ErrorResponse

常見的錯誤碼:

  • ItemNotFound - 找不到要求的專案。

  • InvalidRequest - 更新要求無效。

範例

Update an item example

範例要求

PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715

{
  "displayName": "Item's New name",
  "description": "Item's New description"
}

範例回覆

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

定義

名稱 Description
ErrorRelatedResource

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

ErrorResponse

錯誤回應。

ErrorResponseDetails

錯誤回應詳細數據。

Item

項目物件。

ItemType

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

UpdateItemRequest

更新專案要求。

ErrorRelatedResource

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

名稱 類型 Description
resourceId

string

發生錯誤的資源識別碼。

resourceType

string

發生錯誤的資源類型。

ErrorResponse

錯誤回應。

名稱 類型 Description
errorCode

string

提供錯誤狀況相關信息的特定標識碼,允許服務與其使用者之間的標準化通訊。

message

string

錯誤的人類可讀取表示法。

moreDetails

ErrorResponseDetails[]

其他錯誤詳細數據的清單。

relatedResource

ErrorRelatedResource

錯誤相關的資源詳細數據。

requestId

string

與錯誤相關聯的要求標識碼。

ErrorResponseDetails

錯誤回應詳細數據。

名稱 類型 Description
errorCode

string

提供錯誤狀況相關信息的特定標識碼,允許服務與其使用者之間的標準化通訊。

message

string

錯誤的人類可讀取表示法。

relatedResource

ErrorRelatedResource

錯誤相關的資源詳細數據。

Item

項目物件。

名稱 類型 Description
description

string

專案描述。

displayName

string

項目顯示名稱。

id

string

uuid

項目標識碼。

type

ItemType

項目類型。

workspaceId

string

uuid

工作區標識碼。

ItemType

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

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

倉儲。

UpdateItemRequest

更新專案要求。

名稱 類型 Description
description

string

專案描述。 長度上限為 256 個字元。

displayName

string

項目顯示名稱。 顯示名稱必須依照項目類型遵循命名規則。