Note
Kailangan ng pahintulot para ma-access ang page na ito. Maaari mong subukang mag-sign in o magpalit ng mga direktoryo.
Ang pag-access sa pahinang ito ay nangangailangan ng pahintulot. Maaari mong subukang baguhin ang mga direktoryo.
Notebook Utilities (NotebookUtils) is a built-in package to help you easily perform common tasks in Fabric Notebook. You can use NotebookUtils to work with file systems, to get environment variables, to chain notebooks together, and to work with secrets. The NotebookUtils package is available in PySpark (Python) Scala, SparkR notebooks, and Fabric pipelines.
Note
- MsSparkUtils is officially renamed to NotebookUtils. The existing code remains backward compatible and doesn't cause any breaking changes. It's strongly recommended to upgrade to notebookutils to ensure continued support and access to new features. The mssparkutils namespace will be retired in the future.
- NotebookUtils is designed to work with Spark 3.4 (Runtime v1.2) and above. All new features and updates are exclusively supported with the notebookutils namespace going forward.
NotebookUtils modules
NotebookUtils provides the following modules. Select a module to see detailed documentation, code examples, and best practices.
| Module | Namespace | Description |
|---|---|---|
| File system utilities | notebookutils.fs |
Work with files and directories across ADLS Gen2, Azure Blob Storage, and Lakehouse storage. Includes copy, move, read, write, delete, and list operations. |
| File mount and unmount | notebookutils.fs |
Attach remote storage (ADLS Gen2) to Spark nodes as local mount points for simplified file access. |
| Notebook run and orchestration | notebookutils.notebook |
Run and chain notebooks together, including parallel execution with DAG support, cross-workspace references, and exit values. |
| Notebook management | notebookutils.notebook |
Programmatically create, get, update, delete, and list notebook artifacts. |
| Credentials utilities | notebookutils.credentials |
Get access tokens for Azure services and retrieve secrets from Azure Key Vault. |
| Lakehouse utilities | notebookutils.lakehouse |
Create, get, update, delete, and manage Lakehouse items and tables programmatically. |
| Runtime context | notebookutils.runtime |
Access session context information including notebook name, workspace details, and execution context. |
| Session management | notebookutils.session |
Stop interactive sessions and restart the Python interpreter. |
| User Data Function (UDF) utilities | notebookutils.udf |
Retrieve and invoke User Data Functions from notebooks. |
| Variable library utilities | notebookutils.variableLibrary |
Access centrally managed variables and configuration from Variable Library items. |
To get an overview of all available modules and methods, run:
notebookutils.help()
To get help for a specific module, run:
notebookutils.fs.help()
notebookutils.notebook.help()
notebookutils.credentials.help()
Known issues
- When using runtime version above 1.2 and running
notebookutils.help(), the listed fabricClient and PBIClient APIs aren't supported yet, but they'll be available in a future release.