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

az synapse notebook

参考

管理 Synapse 的笔记本。

命令

名称	说明	类型	Status
az synapse notebook create	创建笔记本。	核心	GA
az synapse notebook delete	删除笔记本。	核心	GA
az synapse notebook export	导出笔记本。	核心	GA
az synapse notebook import	导入笔记本。	核心	GA
az synapse notebook list	列出笔记本。	核心	GA
az synapse notebook set	设置现有笔记本。	核心	GA
az synapse notebook show	获取笔记本。	核心	GA

az synapse notebook create

编辑

创建笔记本。

az synapse notebook create --file
                           --name
                           --workspace-name
                           [--executor-count]
                           [--executor-size {Large, Medium, Small}]
                           [--folder-path]
                           [--no-wait]
                           [--spark-pool-name]

示例

创建笔记本。请注意在文件路径的前面添加“@”作为 JSON 字符串等复杂参数的最佳做法。

az synapse notebook create --workspace-name testsynapseworkspace \
  --name testnotebook --file @"path/notebook.ipynb" --folder-path 'folder/subfolder'

必需参数

--file

可以使用语法或 JSON 字符串从 JSON 文件 @{path} 提供属性。

--name -n

笔记本名称。

--workspace-name

工作区名称。

可选参数

--executor-count

在作业的指定 Spark 池中分配的执行程序数。

默认值: 2

--executor-size

要用于作业的指定 Spark 池中分配的执行程序的核心和内存数。

接受的值: Large, Medium, Small

默认值: Small

--folder-path

此笔记本所在的文件夹。如果未指定，此笔记本将显示在根级别。例如：folder/subfolder1。

--no-wait

不等待长时间运行的操作完成。

默认值: False

--spark-pool-name

Spark 池的名称。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az synapse notebook delete

编辑

删除笔记本。

az synapse notebook delete --name
                           --workspace-name
                           [--no-wait]
                           [--yes]

示例

删除笔记本。

az synapse notebook delete --workspace-name testsynapseworkspace \
  --name testnotebook

必需参数

--name -n

笔记本名称。

--workspace-name

工作区名称。

可选参数

--no-wait

不等待长时间运行的操作完成。

默认值: False

--yes -y

不提示确认。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az synapse notebook export

编辑

导出笔记本。

az synapse notebook export --output-folder
                           --workspace-name
                           [--name]

示例

导出笔记本。

az synapse notebook export --workspace-name testsynapseworkspace \
  --name testnotebook --output-folder C:/output

导出工作区下的所有笔记本。

az synapse notebook export --workspace-name testsynapseworkspace \
  --output-folder C:/output

必需参数

--output-folder

应放置笔记本的文件夹。

--workspace-name

工作区名称。

可选参数

--name -n

笔记本名称。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az synapse notebook import

编辑

导入笔记本。

az synapse notebook import --file
                           --name
                           --workspace-name
                           [--executor-count]
                           [--executor-size {Large, Medium, Small}]
                           [--folder-path]
                           [--no-wait]
                           [--spark-pool-name]

示例

导入笔记本。请注意在文件路径的前面添加“@”作为 JSON 字符串等复杂参数的最佳做法。

az synapse notebook import --workspace-name testsynapseworkspace \
  --name testnotebook --file @"path/notebook.ipynb" --folder-path 'folder/subfolder'

必需参数

--file

可以使用语法或 JSON 字符串从 JSON 文件 @{path} 提供属性。

--name -n

笔记本名称。

--workspace-name

工作区名称。

可选参数

--executor-count

在作业的指定 Spark 池中分配的执行程序数。

默认值: 2

--executor-size

要用于作业的指定 Spark 池中分配的执行程序的核心和内存数。

接受的值: Large, Medium, Small

默认值: Small

--folder-path

此笔记本所在的文件夹。如果未指定，此笔记本将显示在根级别。例如：folder/subfolder1。

--no-wait

不等待长时间运行的操作完成。

默认值: False

--spark-pool-name

Spark 池的名称。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az synapse notebook list

编辑

列出笔记本。

az synapse notebook list --workspace-name

示例

列出笔记本。

az synapse notebook list --workspace-name testsynapseworkspace

必需参数

--workspace-name

工作区名称。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az synapse notebook set

编辑

设置现有笔记本。

az synapse notebook set --file
                        --name
                        --workspace-name
                        [--executor-count]
                        [--executor-size {Large, Medium, Small}]
                        [--folder-path]
                        [--no-wait]
                        [--spark-pool-name]

示例

设置现有笔记本。请注意在文件路径的前面添加“@”作为 JSON 字符串等复杂参数的最佳做法。

az synapse notebook set --workspace-name testsynapseworkspace \
  --name testnotebook --file @"path/notebook.ipynb" --folder-path 'folder/subfolder'

必需参数

--file

可以使用语法或 JSON 字符串从 JSON 文件 @{path} 提供属性。

--name -n

笔记本名称。

--workspace-name

工作区名称。

可选参数

--executor-count

在作业的指定 Spark 池中分配的执行程序数。

默认值: 2

--executor-size

要用于作业的指定 Spark 池中分配的执行程序的核心和内存数。

接受的值: Large, Medium, Small

默认值: Small

--folder-path

此笔记本所在的文件夹。如果未指定，此笔记本将显示在根级别。例如：folder/subfolder1。

--no-wait

不等待长时间运行的操作完成。

默认值: False

--spark-pool-name

Spark 池的名称。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az synapse notebook show

编辑

获取笔记本。

az synapse notebook show --name
                         --workspace-name

示例

获取笔记本。

az synapse notebook show --workspace-name testsynapseworkspace \
  --name testnotebook

必需参数

--name -n

笔记本名称。

--workspace-name

工作区名称。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

通过

az synapse notebook

命令

az synapse notebook create

示例

必需参数

可选参数

az synapse notebook delete

示例

必需参数

可选参数

az synapse notebook export

示例

必需参数

可选参数

az synapse notebook import

示例

必需参数

可选参数

az synapse notebook list

示例

必需参数

az synapse notebook set

示例

必需参数

可选参数

az synapse notebook show

示例

必需参数

其他资源