az synapse notebook

管理 Synapse 的筆記本。

命令

名稱	Description	類型	狀態
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

此筆記本位於的資料夾。 如果未指定，此筆記本將會出現在根層級。 例如：資料夾/子資料夾1。

--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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

此筆記本位於的資料夾。 如果未指定，此筆記本將會出現在根層級。 例如：資料夾/子資料夾1。

--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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

此筆記本位於的資料夾。 如果未指定，此筆記本將會出現在根層級。 例如：資料夾/子資料夾1。

--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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。