Share via

az synapse notebook

  • Reference

Manage Synapse's notebooks.

Commands

Name Description Type Status
az synapse notebook create

Create a notebook.

 Core GA
az synapse notebook delete

Delete a notebook.

 Core GA
az synapse notebook export

Export notebooks.

 Core GA
az synapse notebook import

Import a notebook.

 Core GA
az synapse notebook list

List notebooks.

 Core GA
az synapse notebook set

Set an exist notebook.

 Core GA
az synapse notebook show

Get a notebook.

 Core GA

az synapse notebook create

Edit

Create a notebook.

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

Examples

Create a notebook. Pay attention to add "@" at the front of the file path as the best practice for complex arguments like JSON string.

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

Required Parameters

--file

Properties may be supplied from a JSON file using the @{path} syntax or a JSON string.

--name -n

The notebook name.

--workspace-name

The workspace name.

Optional Parameters

--executor-count

Number of executors to be allocated in the specified Spark pool for the job.

Default value: 2
--executor-size

Number of core and memory to be used for executors allocated in the specified Spark pool for the job.

Accepted values: Large, Medium, Small
Default value: Small
--folder-path

The folder that this notebook is in. If not specified, this notebook will appear at the root level. Eg: folder/subfolder1.

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
--spark-pool-name

The name of the Spark pool.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse notebook delete

Edit

Delete a notebook.

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

Examples

Delete a notebook.

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

Required Parameters

--name -n

The notebook name.

--workspace-name

The workspace name.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse notebook export

Edit

Export notebooks.

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

Examples

Export a notebook.

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

Export all notebooks under a workspace.

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

Required Parameters

--output-folder

The folder where the notebook should be placed.

--workspace-name

The workspace name.

Optional Parameters

--name -n

The notebook name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse notebook import

Edit

Import a notebook.

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

Examples

Import a notebook. Pay attention to add "@" at the front of the file path as the best practice for complex arguments like JSON string.

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

Required Parameters

--file

Properties may be supplied from a JSON file using the @{path} syntax or a JSON string.

--name -n

The notebook name.

--workspace-name

The workspace name.

Optional Parameters

--executor-count

Number of executors to be allocated in the specified Spark pool for the job.

Default value: 2
--executor-size

Number of core and memory to be used for executors allocated in the specified Spark pool for the job.

Accepted values: Large, Medium, Small
Default value: Small
--folder-path

The folder that this notebook is in. If not specified, this notebook will appear at the root level. Eg: folder/subfolder1.

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
--spark-pool-name

The name of the Spark pool.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse notebook list

Edit

List notebooks.

az synapse notebook list --workspace-name

Examples

List notebooks.

az synapse notebook list --workspace-name testsynapseworkspace

Required Parameters

--workspace-name

The workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse notebook set

Edit

Set an exist notebook.

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

Examples

Set an exist notebook. Pay attention to add "@" at the front of the file path as the best practice for complex arguments like JSON string.

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

Required Parameters

--file

Properties may be supplied from a JSON file using the @{path} syntax or a JSON string.

--name -n

The notebook name.

--workspace-name

The workspace name.

Optional Parameters

--executor-count

Number of executors to be allocated in the specified Spark pool for the job.

Default value: 2
--executor-size

Number of core and memory to be used for executors allocated in the specified Spark pool for the job.

Accepted values: Large, Medium, Small
Default value: Small
--folder-path

The folder that this notebook is in. If not specified, this notebook will appear at the root level. Eg: folder/subfolder1.

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
--spark-pool-name

The name of the Spark pool.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse notebook show

Edit

Get a notebook.

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

Examples

Get a notebook.

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

Required Parameters

--name -n

The notebook name.

--workspace-name

The workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.