Items - Update Logical Id

服務:

Core

API 版本:

v1

更新指定項目的邏輯 ID。
對應的項目實例共享相同的邏輯 ID。 使用此操作來解決邏輯識別碼衝突。 在更改邏輯 ID 前，先檢視任何依賴其當前值的自動化，並視需要更新。 否則，這些自動化可能會找不到該項目，或因為顯示名稱重複而失敗。 欲了解更多資訊，請參閱 Microsoft Fabric 中的邏輯 ID 衝突解決。

Permissions

呼叫端必須具有專案的 讀取和寫入 許可權。

必要的委派範圍

對於項目 API，請使用以下其中一種範圍類型：

• 通用範圍：Item.ReadWrite.All.
• 具體範圍： itemType。ReadWrite.All（例如，Notebook.ReadWrite.All）。

欲了解更多關於示波器的資訊，請參見「望遠鏡」。

Limitations

• 邏輯 ID 不能是空的 GUID（00000000-0000-0000-0000-000000000000）。
• 邏輯 ID 必須在工作空間內是唯一的。
• 當工作區中啟動 CI/CD 操作時，該操作不被支援。

Microsoft Entra 支援的身份識別

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

Identity	Support
User	Yes
服務主體 和 受控識別	Yes

介面

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

URI 參數

名稱	位於	必要	類型	Description
itemId	path	True	string (uuid)	項目標識碼。
workspaceId	path	True	string (uuid)	工作區識別碼。

要求本文

名稱	必要	類型	Description
logicalId	True	string (uuid)	要更新該物品的邏輯 ID。

回覆

名稱	類型	Description
200 OK	LogicalIdResponse	要求成功完成。
429 Too Many Requests	ErrorResponse	服務費率上限被超標。 伺服器會回傳一個 Retry-After 標頭，以秒數表示客戶端在發送額外請求前必須等待多久。 標題 Retry-After: integer
Other Status Codes	ErrorResponse	常見的錯誤碼： ItemNotFound - 找不到要求的專案。 ActiveCiCdOperationInProgress - 工作空間中啟動 CI/CD 操作。

範例

Update logical ID example

範例要求

HTTP

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

{
  "logicalId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}

範例回覆

狀態碼:

200

{
  "logicalId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}

定義

名稱	Description
ErrorParameter	一個結構化參數，提供關於錯誤的額外機器可讀上下文。
ErrorRelatedResource	錯誤相關的資源詳細資料物件。
ErrorResponse	錯誤回應。
ErrorResponseDetails	錯誤回應的細節。
LogicalIdResponse	邏輯識別回應。
UpdateLogicalIdRequest	更新邏輯識別碼請求有效載荷。

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	與錯誤相關的資源詳情。

LogicalIdResponse

Object

邏輯識別回應。

名稱	類型	Description
logicalId	string (uuid)	項目的邏輯標識碼。

UpdateLogicalIdRequest

Object

更新邏輯識別碼請求有效載荷。

名稱	類型	Description
logicalId	string (uuid)	要更新該物品的邏輯 ID。