az synapse notebook

  • リファレンス

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

コマンド

名前 説明 型 Status
az synapse notebook create

Notebook を作成します。

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

編集

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

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

--name -n

ノートブック名。

--workspace-name

ワークスペース名。

省略可能のパラメーター

--executor-count

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

既定値: 2
--executor-size

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

承認された値: 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 文字列を使用して @{path} JSON ファイルから指定できます。

--name -n

ノートブック名。

--workspace-name

ワークスペース名。

省略可能のパラメーター

--executor-count

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

既定値: 2
--executor-size

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

承認された値: 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 文字列を使用して @{path} JSON ファイルから指定できます。

--name -n

ノートブック名。

--workspace-name

ワークスペース名。

省略可能のパラメーター

--executor-count

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

既定値: 2
--executor-size

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

承認された値: 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 を使います。