notebookutils1.6.2 package

Dummy R APIs Used in 'Azure Synapse Analytics' for Local Developments

mssparkutils.fs.mv

Moves a file or directory, possibly across FileSystems. For intra-File...

mssparkutils.fs.put

Writes the given String out to a file, encoded in UTF-8.

mssparkutils.fs.refreshMounts

Refresh workspace level mount points.

mssparkutils.fs.rm

Removes a file or directory.

mssparkutils.fs.unmount

Removes a mount point.

mssparkutils.fs.unmountFromDriverNode

Removes a mount point from driver node.

mssparkutils.help

Get help message for this module.

mssparkutils.lakehouse.create

Create a lakehouse

mssparkutils.lakehouse.delete

Delete a lakehouse

mssparkutils.lakehouse.get

Get a lakehouse

mssparkutils.lakehouse.help

The lakehouse module.

mssparkutils.lakehouse.list

List all lakehouses

mssparkutils.lakehouse.update

Update a lakehouse

mssparkutils.nbResPath

Gets the local path of the notebook resource.

mssparkutils.notebook.exit

This method lets you exit a notebook with a value.

mssparkutils.notebook.help

The notebook module.

mssparkutils.notebook.run

Runs a notebook and returns its exit value. The notebook will run in t...

mssparkutils.notebook.runMultiple

Runs multiple notebooks concurrently with support for dependency relat...

mssparkutils.notebook.updateNBSEndpoint

provide a way to make people can update the endpoint

mssparkutils.notebook.validateDAG

Check if the DAG is correctly defined, if the syntax is correct, and i...

mssparkutils.runtime.context

Get runtime properties

mssparkutils.runtime.setHcReplId

Set runtime high concurrency mode repl id

mssparkutils.session.stop

Stop an interactive session

notebookutils.conf.get

Get a config value

notebookutils.conf.set

Set a config key/value

notebookutils.connections.getCredential

Get credential for a connection

notebookutils.connections.getHelpString

Get help string for a method.

notebookutils.credentials.getConnectionStringOrCreds

Take linked service name as input and return connection string or cred...

notebookutils.credentials.getFullConnectionString

Take linked service name as input and return full connection string wi...

notebookutils.credentials.getPropertiesAll

Return all the properties of a given linked service in string format.

notebookutils.credentials.getSecret

Return AKV secret.

notebookutils.credentials.getSecretWithLS

Return AKV secret using linkedService.

notebookutils.credentials.getToken

Get AAD token for a resource.

notebookutils.credentials.help

Get help message.

notebookutils.credentials.isValidToken

Returns true if the input token is valid (i.e, hasn't expired).

notebookutils.credentials.putSecret

Put AKV secret using with or without linkedService.

notebookutils.credentials.putSecretWithLS

Put AKV secret using linkedService.

notebookutils.env.getClusterId

Get cluster id.

notebookutils.env.getJobId

Get job Id.

notebookutils.env.getPoolName

Get pool name.

notebookutils.env.getUserId

Get user Id.

notebookutils.env.getUserName

Get user name.

notebookutils.env.getWorkspaceName

Get workspace name.

notebookutils.env.help

Get help message.

notebookutils.fabricClient.delete

Send a DELETE request to Fabric.

notebookutils.fabricClient.get

Send a GET request to Fabric.

notebookutils.fabricClient.help

Get help string for a method.

notebookutils.fabricClient.listCapacities

List all capacities in the workspace.

notebookutils.fabricClient.patch

Send a PATCH request to Fabric.

notebookutils.fabricClient.post

Send a POST request to Fabric.

notebookutils.fabricClient.put

Send a PUT request to Fabric.

notebookutils.fs.append

Append the given String to a file, encoded in UTF-8.

notebookutils.fs.cp

Copies a file or directory, possibly across FileSystems.

notebookutils.fs.exists

Check if a file or directory exists.

notebookutils.fs.fastcp

Copies a file or directory via azcopy, possibly across FileSystems.

notebookutils.fs.getMountPath

Gets the local path of the mount point.

notebookutils.fs.head

Returns up to the first 'maxBytes' bytes of the given file as a String...

notebookutils.fs.help

notebookutils.fs provides utilities for working with various FileSyste...

notebookutils.fs.ls

Lists the contents of a directory.

notebookutils.fs.mkdirs

Creates the given directory if it does not exist, also creating any ne...

notebookutils.fs.mount

Attach remote storage (Blob, Gen2, Azure File Share) to all working no...

notebookutils.fs.mounts

Show information about what is mounted. Any credentials used to mount ...

notebookutils.fs.mountToDriverNode

Attach remote storage (Blob, Gen2, Azure File Share) to driver node

notebookutils.fs.mv

Moves a file or directory, possibly across FileSystems. For intra-File...

notebookutils.fs.put

Writes the given String out to a file, encoded in UTF-8.

notebookutils.fs.refreshMounts

Refresh workspace level mount points.

notebookutils.fs.rm

Removes a file or directory.

notebookutils.fs.unmount

Removes a mount point.

notebookutils.fs.unmountFromDriverNode

Removes a mount point from driver node.

notebookutils.help

Get help message for this module.

notebookutils.initialize

Initialize notebookutils, using in pre-run code

notebookutils.lakehouse.create

Create a lakehouse

notebookutils.lakehouse.delete

Delete a lakehouse

notebookutils.lakehouse.get

Get a lakehouse

notebookutils.lakehouse.getDefinition

Get the definition of a lakehouse

notebookutils.lakehouse.getWithProperties

Get the info of a Lakehouse with properties.

notebookutils.lakehouse.help

The lakehouse module.

notebookutils.lakehouse.list

List all lakehouses

notebookutils.lakehouse.listTables

List all tables in a Lakehouse.

notebookutils.lakehouse.loadTable

Starts a load table operation.

notebookutils.lakehouse.update

Update a lakehouse

notebookutils.lakehouse.updateDefinition

Get the definition of a lakehouse

notebookutils.nbResPath

Gets the local path of the notebook resource.

notebookutils.notebook.create

Create a notebook

notebookutils.notebook.delete

Delete a notebook

notebookutils.notebook.exit

This method lets you exit a notebook with a value.

notebookutils.notebook.get

Get a notebook

notebookutils.notebook.help

The notebook module.

notebookutils.notebook.list

List all notebooks

notebookutils.notebook.run

Runs a notebook and returns its exit value. The notebook will run in t...

notebookutils.notebook.update

Update a notebook

notebookutils.notebook.updateDefinition

Get the definition of a notebook

notebookutils.notebook.updateNBSEndpoint

provide a way to make people can update the endpoint

notebookutils.notebook.validateDAG

Check if the DAG is correctly defined, if the syntax is correct, and i...

notebookutils.runtime.context

Get runtime properties

notebookutils.runtime.help

notebookutils.runtime is a utility to manage runtime context. context(...

notebookutils.runtime.setHcReplId

Set runtime high concurrency mode repl id

notebookutils.session.stop

Stop an interactive session

notebookutils.udf.getFunctions

Get UDF functions metadata.

notebookutils.udf.getHelpString

Get help string for a method.

notebookutils.udf.help

Get help string for a method.

notebookutils.udf.run

Run a User data functions (UDF).

notebookutils.variableLibrary.get

Get a variable value

notebookutils.variableLibrary.getHelpString

Get help string for a method.

notebookutils.variableLibrary.getLibrary

Get a variable library

mssparkutils.credentials.putSecretWithLS

Put AKV secret using linkedService.

mssparkutils.env.getClusterId

Get cluster id.

mssparkutils.env.getJobId

Get job Id.

mssparkutils.env.getPoolName

Get pool name.

mssparkutils.env.getUserId

Get user Id.

mssparkutils.env.getUserName

Get user name.

mssparkutils.env.getWorkspaceName

Get workspace name.

mssparkutils.env.help

Get help message.

mssparkutils.fs.append

Append the given String to a file, encoded in UTF-8.

mssparkutils.fs.cp

Copies a file or directory, possibly across FileSystems.

mssparkutils.fs.exists

Check if a file or directory exists.

mssparkutils.fs.fastcp

Copies a file or directory via azcopy, possibly across FileSystems.

mssparkutils.fs.getMountPath

Gets the local path of the mount point.

mssparkutils.fs.head

Returns up to the first 'maxBytes' bytes of the given file as a String...

mssparkutils.fs.help

mssparkutils.fs provides utilities for working with various FileSystem...

mssparkutils.fs.ls

Lists the contents of a directory.

mssparkutils.fs.mkdirs

Creates the given directory if it does not exist, also creating any ne...

mssparkutils.fs.mount

Attach remote storage (Blob, Gen2, Azure File Share) to all working no...

mssparkutils.fs.mounts

Show information about what is mounted. Any credentials used to mount ...

mssparkutils.fs.mountToDriverNode

Attach remote storage (Blob, Gen2, Azure File Share) to driver node

mssparkutils.credentials.getSecretWithLS

Return AKV secret using linkedService.

mssparkutils.credentials.getToken

Get AAD token for a resource.

mssparkutils.credentials.help

Get help message.

mssparkutils.credentials.isValidToken

Returns true if the input token is valid (i.e, hasn't expired).

mssparkutils.credentials.putSecret

Put AKV secret using with or without linkedService.

display.config

Set the chart config metadata for current dataframe (set by display)...

display.configCustomOptions

Set the visualizer custom options related to the current dataframe, it...

display

Set the dataframe info which needs to be visualized.

displayHTML

Construct an specific html fragment to synapse notebook front-end for ...

mssparkutils.credentials.getConnectionStringOrCreds

Take linked service name as input and return connection string or cred...

mssparkutils.credentials.getFullConnectionString

Take linked service name as input and return full connection string wi...

mssparkutils.credentials.getPropertiesAll

Return all the properties of a given linked service in string format.

mssparkutils.credentials.getSecret

Return AKV secret.

This is a pure dummy interfaces package which mirrors 'MsSparkUtils' APIs <https://learn.microsoft.com/en-us/azure/synapse-analytics/spark/microsoft-spark-utilities?pivots=programming-language-r> of 'Azure Synapse Analytics' <https://learn.microsoft.com/en-us/azure/synapse-analytics/> for R users, customer of Azure Synapse can download this package from CRAN for local development.

  • Maintainer: runtimeexp
  • License: MIT + file LICENSE
  • Last published: 2026-01-26