Items - Create Notebook

服务:: Notebook

API 版本:: v1

在指定的工作区中创建笔记本。
此 API 支持长时间运行的作（LRO）。

若要创建具有定义的笔记本，请参阅笔记本定义一文。

权限

调用方必须具有 参与者 工作区角色。

所需的委派范围

Notebook.ReadWrite.All 或 Item.ReadWrite.All

局限性

若要创建笔记本，工作区必须位于受支持的 Fabric 容量上。有关详细信息，请参阅：Microsoft Fabric 许可证类型。

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

身份	支持
用户	是的
服务主体和托管标识	是的

接口

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

URI 参数

名称	在	必需	类型	说明
workspaceId	path	True	string (uuid)	工作区 ID。

请求正文

名称	必需	类型	说明
displayName	True	string	笔记本显示名称。显示名称必须遵循项类型的命名规则。
definition		NotebookDefinition	笔记本公共定义。
description		string	笔记本说明。最大长度为 256 个字符。
folderId		string (uuid)	文件夹 ID。如果未指定或为 null，则会使用工作区作为其文件夹创建笔记本。

响应

名称	类型	说明
201 Created	Notebook	已成功创建
202 Accepted		请求接受，正在进行笔记本预配。标头 Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	常见错误代码： InvalidItemType - 项类型无效 ItemDisplayNameAlreadyInUse - 项显示名称已被使用。 CorruptedPayload - 提供的有效负载已损坏。 WorkspaceItemsLimitExceeded - 超出工作区项限制。

名称

类型

说明

201 Created

Notebook

已成功创建

202 Accepted

请求接受，正在进行笔记本预配。

标头

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

常见错误代码：

InvalidItemType - 项类型无效
ItemDisplayNameAlreadyInUse - 项显示名称已被使用。
CorruptedPayload - 提供的有效负载已损坏。
WorkspaceItemsLimitExceeded - 超出工作区项限制。

示例

Create a notebook example

Create a notebook with public definition in fabricGitSource format example

Create a notebook with public definition in ipynb format example

Create a notebook example

示例请求

HTTP

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

{
  "displayName": "Notebook 1",
  "description": "A notebook description."
}

示例响应

状态代码:: 201

{
  "displayName": "Notebook 1",
  "description": "A notebook description.",
  "type": "Notebook",
  "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

Create a notebook with public definition in fabricGitSource format example

示例请求

HTTP

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

{
  "displayName": "Notebook 1",
  "description": "A notebook description",
  "definition": {
    "format": "fabricGitSource",
    "parts": [
      {
        "path": "notebook-content.py",
        "payload": "eyJuYmZvcm1hdCI6N..5ndWUiOiJweXRob24ifX19",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

示例响应

状态代码:: 201

{
  "displayName": "Notebook 1",
  "description": "A notebook description",
  "type": "Notebook",
  "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

Create a notebook with public definition in ipynb format example

示例请求

HTTP

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

{
  "displayName": "Notebook 1",
  "description": "A notebook description",
  "definition": {
    "format": "ipynb",
    "parts": [
      {
        "path": "notebook-content.ipynb",
        "payload": "eyJuYmZvcm1hdCI6N..5ndWUiOiJweXRob24ifX19",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

示例响应

状态代码:: 201

{
  "displayName": "Notebook 1",
  "description": "A notebook description",
  "type": "Notebook",
  "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

定义

名称	说明
CreateNotebookRequest	创建笔记本请求有效负载。
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
ItemTag	表示应用于项的标记。
ItemType	项的类型。可能会随着时间的推移添加其他项类型。
Notebook	笔记本对象。
NotebookDefinition	笔记本公共定义对象。有关如何创建笔记本公共定义的更多详细信息，请参阅此文章。
NotebookDefinitionPart	笔记本定义部件对象。
PayloadType	定义部件有效负载的类型。可能会随着时间的推移添加其他有效负载类型。

CreateNotebookRequest

对象

创建笔记本请求有效负载。

名称	类型	说明
definition	NotebookDefinition	笔记本公共定义。
description	string	笔记本说明。最大长度为 256 个字符。
displayName	string	笔记本显示名称。显示名称必须遵循项类型的命名规则。
folderId	string (uuid)	文件夹 ID。如果未指定或为 null，则会使用工作区作为其文件夹创建笔记本。

ErrorRelatedResource

对象

与错误相关的资源详细信息对象。

名称	类型	说明
resourceId	string	错误中涉及的资源 ID。
resourceType	string	错误中涉及的资源的类型。

ErrorResponse

对象

错误响应。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
moreDetails	ErrorResponseDetails[]	其他错误详细信息的列表。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。
requestId	string	与错误关联的请求的 ID。

ErrorResponseDetails

对象

错误响应详细信息。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。

ItemTag

对象

表示应用于项的标记。

名称	类型	说明
displayName	string	标签的名称。
id	string (uuid)	标记 ID。

ItemType

枚举

项的类型。可能会随着时间的推移添加其他项类型。

值	说明
Dashboard	PowerBI 仪表板。
Report	PowerBI 报表。
SemanticModel	PowerBI 语义模型。
PaginatedReport	PowerBI 分页报表。
Datamart	PowerBI Datamart。
Lakehouse	湖屋
Eventhouse	事件屋。
Environment	环境。
KQLDatabase	KQL 数据库。
KQLQueryset	KQL 查询集。
KQLDashboard	KQL 仪表板。
DataPipeline	数据管道。
Notebook	笔记本。
SparkJobDefinition	spark 作业定义。
MLExperiment	机器学习试验。
MLModel	机器学习模型。
Warehouse	仓库。
Eventstream	事件流。
SQLEndpoint	SQL 终结点。
MirroredWarehouse	镜像仓库。
MirroredDatabase	镜像数据库。
Reflex	反射。
GraphQLApi	GraphQL 项的 API。
MountedDataFactory	MountedDataFactory。
SQLDatabase	SQLDatabase。
CopyJob	复制作业。
VariableLibrary	VariableLibrary。
Dataflow	数据流。
ApacheAirflowJob	ApacheAirflowJob。
WarehouseSnapshot	仓库快照。
DigitalTwinBuilder	DigitalTwinBuilder。
DigitalTwinBuilderFlow	数字孪生生成器流。
MirroredAzureDatabricksCatalog	镜像的 Azure databricks 目录。
Map	地图。
AnomalyDetector	异常检测器。
UserDataFunction	用户数据函数。
GraphModel	GraphModel。
GraphQuerySet	图形查询集。
SnowflakeDatabase	用于存储从 Snowflake 帐户创建的 Iceberg 表的 Snowflake 数据库。
OperationsAgent	OperationsAgent。
CosmosDBDatabase	Cosmos DB 数据库。

Notebook

对象

笔记本对象。

名称	类型	说明
description	string	项说明。
displayName	string	项显示名称。
folderId	string (uuid)	文件夹 ID。
id	string (uuid)	项 ID。
tags	ItemTag[]	已应用的标记列表。
type	ItemType	项类型。
workspaceId	string (uuid)	工作区 ID。

NotebookDefinition

对象

笔记本公共定义对象。有关如何创建笔记本公共定义的更多详细信息，请参阅此文章。

名称	类型	说明
format	string	Notebook 定义的格式。支持的格式： `ipynb` 和 `fabricGitSource`。如果未提供格式， `fabricGitSource` 则使用。
parts	NotebookDefinitionPart[]	定义部件的列表。

NotebookDefinitionPart

对象

笔记本定义部件对象。

名称	类型	说明
path	string	笔记本部件路径。支持的笔记本内容扩展：`.ipynb`格式`ipynb`;`.py`、`.scala`、`.r.sql`格式`fabricGitSource`。
payload	string	笔记本部件有效负载。
payloadType	PayloadType	有效负载类型。

PayloadType

枚举

定义部件有效负载的类型。可能会随着时间的推移添加其他有效负载类型。

值	说明
InlineBase64	内联基线 64。

通过

Items - Create Notebook

权限

所需的委派范围

局限性

Microsoft Entra 支持的标识

接口

URI 参数

请求正文

响应

示例

Create a notebook example

示例请求

示例响应

Create a notebook with public definition in fabricGitSource format example

示例请求

示例响应

Create a notebook with public definition in ipynb format example

示例请求

示例响应

定义

CreateNotebookRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

Notebook

NotebookDefinition

NotebookDefinitionPart

PayloadType