通过

Items - Get Notebook Definition

服务:
Notebook
API 版本:
v1

返回指定的笔记本公共定义。
此 API 支持 长时间运行的作（LRO）。

获取笔记本的公共定义时，敏感度标签不是定义的一部分。

权限

调用方必须具有笔记本的 读取和写入 权限。

所需的委派范围

Notebook.ReadWrite.All 或 Item.ReadWrite.All

局限性

对于具有加密敏感度标签的笔记本，此 API 被阻止。

Microsoft Entra 支持的标识

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

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

接口

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}/getDefinition
具有可选参数: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}/getDefinition?format={format}

URI 参数

名称 在 必需 类型 说明
notebookId
 path True

string (uuid)

笔记本 ID。
workspaceId
 path True

string (uuid)

工作区 ID。
format
 query

string

笔记本公共定义的格式。 支持的格式： ipynb 和 fabricGitSource。 如果未提供格式， fabricGitSource 则使用。

响应

名称 类型 说明
200 OK

NotebookDefinitionResponse

请求成功完成。
202 Accepted

请求已接受。 正在检索定义。

标头

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

常见错误代码：

  • OperationNotSupportedForItem - 请求的项不支持作。

示例

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

Get a notebook definition in fabricGitSource format example

示例请求

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/notebooks/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

示例响应

状态代码:
200 
{
  "definition": {
    "parts": [
      {
        "path": "notebook-content.py",
        "payload": "IyBGYWJyaWMgbm90ZWJv..5ndWUiOiJweXRob24ifX19",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
状态代码:
202 
Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Get a notebook definition in ipynb format example

示例请求

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/notebooks/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition?format=ipynb

示例响应

状态代码:
200 
{
  "definition": {
    "parts": [
      {
        "path": "notebook-content.ipynb",
        "payload": "IyBGYWJyaWMgbm90ZWJv..5ndWUiOiJweXRob24ifX19",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
状态代码:
202 
Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

定义

名称 说明
ErrorRelatedResource

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

错误响应。
ErrorResponseDetails

错误响应详细信息。
NotebookDefinition

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

笔记本定义部件对象。
NotebookDefinitionResponse

笔记本公共定义响应。
PayloadType

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

ErrorRelatedResource

Object

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

名称 类型 说明
resourceId

string

错误中涉及的资源 ID。
resourceType

string

错误中涉及的资源的类型。

ErrorResponse

Object

错误响应。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
moreDetails

ErrorResponseDetails[]

其他错误详细信息的列表。
relatedResource

ErrorRelatedResource

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

string

与错误关联的请求的 ID。

ErrorResponseDetails

Object

错误响应详细信息。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
relatedResource

ErrorRelatedResource

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

NotebookDefinition

Object

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

名称 类型 说明
format

string

Notebook 定义的格式。 支持的格式： ipynb 和 fabricGitSource。 如果未提供格式， fabricGitSource 则使用。
parts

NotebookDefinitionPart[]

定义部件的列表。

NotebookDefinitionPart

Object

笔记本定义部件对象。

名称 类型 说明
path

string

笔记本部件路径。 支持的笔记本内容扩展：.ipynb格式ipynb;.py、.scala、.r.sql格式fabricGitSource。
payload

string

笔记本部件有效负载。
payloadType

PayloadType

有效负载类型。

NotebookDefinitionResponse

Object

笔记本公共定义响应。

名称 类型 说明
definition

NotebookDefinition

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

PayloadType

枚举

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

值 说明
InlineBase64

内联基线 64。