你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Notebook - Get Notebooks By Workspace

Lists笔记本。

GET {endpoint}/notebooks?api-version=2020-12-01

URI 参数

名称 必需 类型 说明
endpoint
path True

string

uri

工作区开发终结点,例如 https://myworkspace.dev.azuresynapse.net

api-version
query True

string

Synapse 客户端 API 版本。

响应

名称 类型 说明
200 OK

NotebookListResponse

没问题。

Other Status Codes

CloudError

从Azure Synapse服务收到的错误响应。

示例

Notebooks_ListByWorkspace

示例请求

GET exampleWorkspace.dev.azuresynapse.net/notebooks?api-version=2020-12-01

示例响应

Date: Sat, 16 Jun 2018 00:37:41 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1192
x-ms-request-id: e4c589b7-a9fe-4c28-981c-3855ec27d264
x-ms-correlation-request-id: e4c589b7-a9fe-4c28-981c-3855ec27d264
{
  "value": [
    {
      "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/notebooks/exampleNotebook",
      "name": "exampleNotebook",
      "type": "Microsoft.Synapse/workspaces/Notebooks",
      "properties": {
        "description": "A sample Notebook",
        "nbformat": 4,
        "nbformat_minor": 2,
        "bigDataPool": {
          "referenceName": "exampleBigDataPoolName",
          "type": "BigDataPoolReference"
        },
        "sessionProperties": {
          "driverMemory": "28g",
          "driverCores": 4,
          "executorMemory": "28g",
          "executorCores": 4,
          "numExecutors": 1
        },
        "metadata": {
          "language_info": {
            "name": "python"
          },
          "kernelspec": {
            "name": "exampleName",
            "display_name": "exampleDisplayName"
          }
        },
        "cells": [
          {
            "cell_type": "code",
            "metadata": {},
            "source": [
              "def my_function():\n",
              " print(\"Hello from a function\")\n",
              "\n",
              "my_function()"
            ],
            "attachments": {},
            "outputs": [
              {
                "execution_count": 3,
                "output_type": "execute_result",
                "data": {
                  "text/plain": "Hello from a function"
                },
                "metadata": {}
              }
            ]
          }
        ]
      },
      "etag": "1500504f-0000-0200-0000-5cbe090f0000"
    }
  ]
}

定义

名称 说明
BigDataPoolReference

大数据池参考。

BigDataPoolReferenceType

大数据池引用类型。

CellOutputType

执行、显示或流输出。

CloudError

定义Azure Synapse错误响应结构的对象。

Folder

此笔记本所在的文件夹。 如果未指定,此笔记本将显示在根级别。

Notebook

笔记本。

NotebookCell

笔记本单元格。

NotebookCellOutputItem

笔记本单元格执行输出的项。

NotebookKernelSpec

内核信息。

NotebookLanguageInfo

语言信息。

NotebookListResponse

笔记本资源的列表。

NotebookMetadata

笔记本根级元数据。

NotebookResource

笔记本资源类型。

NotebookSessionProperties

会话属性。

SparkConfigurationReference

Spark 配置参考。

SparkConfigurationReferenceType

Spark 配置引用类型。

BigDataPoolReference

大数据池参考。

名称 类型 说明
referenceName

string

引用大数据池名称。

type

BigDataPoolReferenceType

大数据池引用类型。

BigDataPoolReferenceType

大数据池引用类型。

名称 类型 说明
BigDataPoolReference

string

CellOutputType

执行、显示或流输出。

名称 类型 说明
display_data

string

error

string

execute_result

string

stream

string

CloudError

定义Azure Synapse错误响应结构的对象。

名称 类型 说明
error.code

string

错误代码。

error.details

CloudError[]

包含其他错误详细信息的数组。

error.message

string

错误消息。

error.target

string

与错误关联的请求中的属性名称/路径。

Folder

此笔记本所在的文件夹。 如果未指定,此笔记本将显示在根级别。

名称 类型 说明
name

string

此笔记本所在的文件夹的名称。

Notebook

笔记本。

名称 类型 说明
bigDataPool

BigDataPoolReference

大数据池参考。

cells

NotebookCell[]

当前笔记本的单元格数组。

description

string

笔记本的说明。

folder

Folder

此笔记本所在的文件夹。 如果未指定,此笔记本将显示在根级别。

metadata

NotebookMetadata

笔记本根级元数据。

nbformat

integer

笔记本格式 (主数字) 。 在笔记本格式的向后不兼容更改之间递增。

nbformat_minor

integer

笔记本格式 (次要数字) 。 递增,以便对笔记本格式进行向后兼容更改。

sessionProperties

NotebookSessionProperties

会话属性。

targetSparkConfiguration

SparkConfigurationReference

Spark 作业的 spark 配置。

NotebookCell

笔记本单元格。

名称 类型 说明
attachments

object

与单元格关联的附件。

cell_type

string

标识单元格类型的字符串。

metadata

object

单元格级元数据。

outputs

NotebookCellOutputItem[]

单元格级输出项。

source

string[]

单元格的内容,表示为行数组。

NotebookCellOutputItem

笔记本单元格执行输出的项。

名称 类型 说明
data

object

输出数据。 使用 MIME 类型作为键,使用内容作为值。

execution_count

integer

执行序列号。

metadata

object

输出项的元数据。

name

string

对于 output_type=stream,确定 (stdout /stderr) 流的名称。

output_type

CellOutputType

执行、显示或流输出。

text

对于 output_type=stream,流的文本输出,表示为字符串或字符串数组。

NotebookKernelSpec

内核信息。

名称 类型 说明
display_name

string

要显示在 UI 中的名称。

name

string

内核规范的名称。

NotebookLanguageInfo

语言信息。

名称 类型 说明
codemirror_mode

string

用于此语言代码的 codemirror 模式。

name

string

此内核运行的编程语言。

NotebookListResponse

笔记本资源的列表。

名称 类型 说明
nextLink

string

指向下一页结果的链接(如果存在任何剩余结果)。

value

NotebookResource[]

笔记本列表。

NotebookMetadata

笔记本根级元数据。

名称 类型 说明
kernelspec

NotebookKernelSpec

内核信息。

language_info

NotebookLanguageInfo

语言信息。

NotebookResource

笔记本资源类型。

名称 类型 说明
etag

string

资源 Etag。

id

string

资源的完全限定资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

资源的名称

properties

Notebook

Notebook 的属性。

type

string

资源类型。 Ex-Microsoft.Compute/virtualMachines 或 Microsoft.Storage/storageAccounts。

NotebookSessionProperties

会话属性。

名称 类型 说明
driverCores

integer

要用于驱动程序的核心数。

driverMemory

string

用于驱动程序进程的内存量。

executorCores

integer

每个执行程序使用的内核数。

executorMemory

string

每个执行程序进程要使用的内存量。

numExecutors

integer

为此会话启动的执行程序数。

SparkConfigurationReference

Spark 配置参考。

名称 类型 说明
referenceName

string

引用 spark 配置名称。

type

SparkConfigurationReferenceType

Spark 配置引用类型。

SparkConfigurationReferenceType

Spark 配置引用类型。

名称 类型 说明
SparkConfigurationReference

string