次の方法で共有


az synapse notebook

Synapse のノートブックを管理します。

コマンド

名前 説明 状態
az synapse notebook create

Notebook を作成します。

Core GA
az synapse notebook delete

ノートブックを削除します。

Core GA
az synapse notebook export

ノートブックをエクスポートします。

Core GA
az synapse notebook import

ノートブックをインポートします。

Core GA
az synapse notebook list

ノートブックを一覧表示します。

Core GA
az synapse notebook set

存在するノートブックを設定します。

Core GA
az synapse notebook show

ノートブックを取得します。

Core GA

az synapse notebook create

Notebook を作成します。

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

Notebook を作成します。 JSON 文字列などの複雑な引数のベスト プラクティスとして、ファイル パスの先頭に "@" を追加するように注意してください。

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

必須のパラメーター

--file

プロパティは、@{path} 構文または JSON 文字列を使用して JSON ファイルから指定できます。

--name -n

ノートブック名。

--workspace-name

ワークスペース名。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--executor-count

ジョブの指定された Spark プールに割り当てられる Executor の数。

プロパティ
規定値: 2
--executor-size

ジョブの指定された Spark プールに割り当てられた Executor に使用されるコアとメモリの数。

プロパティ
規定値: Small
指定可能な値: Large, Medium, Small
--folder-path

このノートブックが存在するフォルダー。 指定しない場合、このノートブックはルート レベルで表示されます。 例: folder/subfolder1。

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ
規定値: False
--spark-pool-name

Spark プールの名前。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ
規定値: False
--output -o

出力フォーマット。

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

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

ワークスペース名。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ
規定値: False
--yes -y

確認を求めないでください。

プロパティ
規定値: False
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ
規定値: False
--output -o

出力フォーマット。

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

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

ワークスペース名。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--name -n

ノートブック名。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ
規定値: False
--output -o

出力フォーマット。

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

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

プロパティは、@{path} 構文または JSON 文字列を使用して JSON ファイルから指定できます。

--name -n

ノートブック名。

--workspace-name

ワークスペース名。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--executor-count

ジョブの指定された Spark プールに割り当てられる Executor の数。

プロパティ
規定値: 2
--executor-size

ジョブの指定された Spark プールに割り当てられた Executor に使用されるコアとメモリの数。

プロパティ
規定値: Small
指定可能な値: Large, Medium, Small
--folder-path

このノートブックが存在するフォルダー。 指定しない場合、このノートブックはルート レベルで表示されます。 例: folder/subfolder1。

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ
規定値: False
--spark-pool-name

Spark プールの名前。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ
規定値: False
--output -o

出力フォーマット。

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

az synapse notebook list

ノートブックを一覧表示します。

az synapse notebook list --workspace-name

ノートブックを一覧表示します。

az synapse notebook list --workspace-name testsynapseworkspace

必須のパラメーター

--workspace-name

ワークスペース名。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ
規定値: False
--output -o

出力フォーマット。

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

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

プロパティは、@{path} 構文または JSON 文字列を使用して JSON ファイルから指定できます。

--name -n

ノートブック名。

--workspace-name

ワークスペース名。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--executor-count

ジョブの指定された Spark プールに割り当てられる Executor の数。

プロパティ
規定値: 2
--executor-size

ジョブの指定された Spark プールに割り当てられた Executor に使用されるコアとメモリの数。

プロパティ
規定値: Small
指定可能な値: Large, Medium, Small
--folder-path

このノートブックが存在するフォルダー。 指定しない場合、このノートブックはルート レベルで表示されます。 例: folder/subfolder1。

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ
規定値: False
--spark-pool-name

Spark プールの名前。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ
規定値: False
--output -o

出力フォーマット。

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

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

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ
規定値: False
--output -o

出力フォーマット。

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False