Notebook のユーティリティ (NotebookUtils) は、Fabric Notebook で一般的なタスクを簡単に実行するのに役立つビルトイン パッケージです。 NotebookUtils を使用して、ファイル システムを操作したり、環境変数を取得したり、ノートブックを連結したり、シークレットを操作したりすることができます。 NotebookUtils パッケージは、PySpark (Python)、Scala、SparkR ノートブック、Fabric パイプラインで利用できます。
Note
- MsSparkUtils の名前が NotebookUtils に正式に変更されています。 既存のコードは 下位互換性 を維持し、重大な変更は発生しません。 継続的なサポートと新機能へのアクセスを確保するために、notebookutils にアップグレード することを強くお勧めします 。 mssparkutils 名前空間は今後廃止される予定です。
- NotebookUtils は、 Spark 3.4 (ランタイム v1.2) 以降で動作するように設計されています。 今後、notebookutils 名前空間では、すべての新機能と更新プログラムが排他的にサポートされます。
NotebookUtils モジュール
NotebookUtils には、次のモジュールが用意されています。 モジュールを選択すると、詳細なドキュメント、コード例、ベスト プラクティスが表示されます。
| モジュール | 名前空間 | 説明 |
|---|---|---|
| ファイル システム ユーティリティ | notebookutils.fs |
ADLS Gen2、Azure Blob Storage、Lakehouse ストレージ全体のファイルとディレクトリを操作します。 コピー、移動、読み取り、書き込み、削除、およびリスト操作が含まれます。 |
| ファイルのマウントとマウント解除 | notebookutils.fs |
リモート ストレージ (ADLS Gen2) をローカル マウント ポイントとして Spark ノードに接続し、ファイル アクセスを簡略化します。 |
| ノートブックの実行とオーケストレーション | notebookutils.notebook |
DAG サポートによる並列実行、ワークスペース間の参照、終了値を含め、ノートブックを実行し連結できます。 |
| ノートブックの管理 | notebookutils.notebook |
プログラムによってノートブック成果物を作成、取得、更新、削除、および一覧表示します。 |
| 資格情報ユーティリティ | notebookutils.credentials |
Azure サービスのアクセス トークンを取得し、Azure Key Vault からシークレットを取得します。 |
| Lakehouse ユーティリティ | notebookutils.lakehouse |
Lakehouse のアイテムとテーブルをプログラムで作成、取得、更新、削除、管理します。 |
| ランタイム コンテキスト | notebookutils.runtime |
ノートブック名、ワークスペースの詳細、実行コンテキストなどのセッション コンテキスト情報にアクセスします。 |
| セッション管理 | notebookutils.session |
対話型セッションを停止し、Python インタープリターを再起動します。 |
| ユーザー データ関数 (UDF) ユーティリティ | notebookutils.udf |
ノートブックからユーザー データ関数を取得して呼び出します。 |
| 変数ライブラリ ユーティリティ | notebookutils.variableLibrary |
変数ライブラリ項目から一元的に管理された変数と構成にアクセスします。 |
使用可能なすべてのモジュールとメソッドの概要を取得するには、次を実行します。
notebookutils.help()
特定のモジュールのヘルプを表示するには、次を実行します。
notebookutils.fs.help()
notebookutils.notebook.help()
notebookutils.credentials.help()
既知の問題
- 1.2 より前のランタイム バージョンを使用し、
notebookutils.help()を実行している場合、一覧表示されている fabricClient API と PBIClient API はまだサポートされていませんが、将来のリリースで使用できるようになります。