共用方式為

Items - Update Notebook Definition

服務:
Notebook
API 版本:
v1

覆寫指定筆記本的定義。
此 API 支援 長時間執行的作業 （LRO）。

更新筆記本的定義不會影響其敏感度標籤。

權限

呼叫端必須具有筆記本的 讀取和寫入 許可權。

必要的委派範圍

Notebook.ReadWrite.All 或 Item.ReadWrite.All

Microsoft Entra 支援的身份識別

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

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

介面

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}/updateDefinition
含選擇性參數: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}/updateDefinition?updateMetadata={updateMetadata}

URI 參數

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

string (uuid)

筆記本標識碼。
workspaceId
 path True

string (uuid)

工作區識別碼。
updateMetadata
 query

boolean

當設定為 true 且 .platform 檔案是在定義中提供時，會使用 .platform 檔案中的元數據來更新專案的元數據

要求本文

名稱 必要 類型 Description
definition True

NotebookDefinition

Notebook 公用定義物件。 如需如何製作筆記本公用定義的詳細資訊，請參閱此 文章。

回應

名稱 類型 Description
200 OK

要求成功完成。
202 Accepted

已接受要求。 更新定義正在進行中。

標題

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
429 Too Many Requests

ErrorResponse

服務費率上限被超標。 伺服器會回傳一個 Retry-After 標頭，以秒數表示客戶端在發送額外請求前必須等待多久。

標題

Retry-After: integer
Other Status Codes

ErrorResponse

常見的錯誤碼：

  • OperationNotSupportedForItem - 要求專案不支持作業。

  • CorruptedPayload - 提供的承載已損毀。

範例

Update a notebook definition in fabricGitSource format example
Update a notebook definition in ipynb format example

Update a notebook definition in fabricGitSource format example

範例要求

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/notebooks/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "parts": [
      {
        "path": "notebook-content.py",
        "payload": "IyBGYWJyaWMgbm90ZWJv...",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

範例回覆

狀態碼:
200
狀態碼:
202 
Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Update a notebook definition in ipynb format example

範例要求

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/notebooks/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "format": "ipynb",
    "parts": [
      {
        "path": "notebook-content.ipynb",
        "payload": "IyBGYWJyaWMgbm90ZWJv...",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

範例回覆

狀態碼:
200
狀態碼:
202 
Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

定義

名稱 Description
ErrorRelatedResource

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

錯誤回應。
ErrorResponseDetails

錯誤回應詳細數據。
NotebookDefinition

Notebook 公用定義物件。 如需如何製作筆記本公用定義的詳細資訊，請參閱此 文章。
NotebookDefinitionPart

筆記本定義部分物件。
PayloadType

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

更新筆記本公用定義要求承載。

ErrorRelatedResource

Object

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

名稱 類型 Description
resourceId

string

發生錯誤的資源識別碼。
resourceType

string

發生錯誤的資源類型。

ErrorResponse

Object

錯誤回應。

名稱 類型 Description
errorCode

string

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

string

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

ErrorResponseDetails[]

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

ErrorRelatedResource

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

string (uuid)

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

ErrorResponseDetails

Object

錯誤回應詳細數據。

名稱 類型 Description
errorCode

string

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

string

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

ErrorRelatedResource

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

NotebookDefinition

Object

Notebook 公用定義物件。 如需如何製作筆記本公用定義的詳細資訊，請參閱此 文章。

名稱 類型 Description
format

string

Notebook 定義的格式。 支援的格式： ipynb 和 fabricGitSource。 如果未提供任何格式， fabricGitSource 則會使用 。
parts

NotebookDefinitionPart[]

定義元件的清單。

NotebookDefinitionPart

Object

筆記本定義部分物件。

名稱 類型 Description
path

string

筆記本元件路徑。 支援的筆記本內容延伸模組：.ipynb格式ipynb;.py、、、.scala.r.sqlfabricGitSource格式。
payload

string

筆記本元件承載。
payloadType

PayloadType

承載類型。

PayloadType

列舉型別

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

值 Description
InlineBase64

內嵌基底 64。

UpdateNotebookDefinitionRequest

Object

更新筆記本公用定義要求承載。

名稱 類型 Description
definition

NotebookDefinition

Notebook 公用定義物件。 如需如何製作筆記本公用定義的詳細資訊，請參閱此 文章。