Learn R Programming

notebookutils (version 1.6.2)

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

Description

This is a pure dummy interfaces package which mirrors 'MsSparkUtils' APIs of 'Azure Synapse Analytics' for R users, customer of Azure Synapse can download this package from CRAN for local development.

Copy Link

Version

Install

install.packages('notebookutils')

Monthly Downloads

298

Version

1.6.2

License

MIT + file LICENSE

Maintainer

runtimeexp

Last Published

January 26th, 2026

Functions in notebookutils (1.6.2)

mssparkutils.credentials.getFullConnectionString

Take linked service name as input and return full connection string with credentials.
mssparkutils.credentials.putSecret

Put AKV secret using with or without linkedService.
mssparkutils.credentials.putSecretWithLS

Put AKV secret using linkedService.
mssparkutils.fs.mv

Moves a file or directory, possibly across FileSystems. For intra-FileSystem, it is implemented by hadoop fs rename operation. For inter-FileSystem, This is implemented as a copy followed by delete.
mssparkutils.notebook.run

Runs a notebook and returns its exit value. The notebook will run in the current livy session context by default.
mssparkutils.notebook.help

The notebook module.
mssparkutils.fs.mounts

Show information about what is mounted. Any credentials used to mount the mount points listed will not be displayed.
mssparkutils.fs.mkdirs

Creates the given directory if it does not exist, also creating any necessary parent * directories.
mssparkutils.fs.ls

Lists the contents of a directory.
notebookutils.credentials.isValidToken

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

Get user Id.
notebookutils.env.getPoolName

Get pool name.
mssparkutils.session.stop

Stop an interactive session
mssparkutils.runtime.setHcReplId

Set runtime high concurrency mode repl id
notebookutils.credentials.help

Get help message.
mssparkutils.env.getClusterId

Get cluster id.
mssparkutils.env.getUserName

Get user name.
mssparkutils.env.getWorkspaceName

Get workspace name.
mssparkutils.env.getJobId

Get job Id.
mssparkutils.env.getUserId

Get user Id.
mssparkutils.fs.head

Returns up to the first 'maxBytes' bytes of the given file as a String encoded in UTF-8.
mssparkutils.fs.mount

Attach remote storage (Blob, Gen2, Azure File Share) to all working nodes (driver node and worker nodes)
mssparkutils.fs.refreshMounts

Refresh workspace level mount points.
mssparkutils.lakehouse.create

Create a lakehouse
mssparkutils.env.help

Get help message.
mssparkutils.fs.mountToDriverNode

Attach remote storage (Blob, Gen2, Azure File Share) to driver node
mssparkutils.fs.append

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

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

List all lakehouses
display.configCustomOptions

Set the visualizer custom options related to the current dataframe, it will be consumed when executing display.
displayHTML

Construct an specific html fragment to synapse notebook front-end for rendering based on user-input html content.
mssparkutils.credentials.help

Get help message.
mssparkutils.lakehouse.delete

Delete a lakehouse
notebookutils.fs.unmount

Removes a mount point.
notebookutils.fabricClient.patch

Send a PATCH request to Fabric.
notebookutils.fabricClient.listCapacities

List all capacities in the workspace.
notebookutils.fs.unmountFromDriverNode

Removes a mount point from driver node.
notebookutils.notebook.create

Create a notebook
mssparkutils.lakehouse.help

The lakehouse module.
notebookutils.credentials.getSecret

Return AKV secret.
notebookutils.credentials.getPropertiesAll

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

Get a lakehouse
notebookutils.notebook.delete

Delete a notebook
mssparkutils.fs.help

mssparkutils.fs provides utilities for working with various FileSystems.
notebookutils.notebook.run

Runs a notebook and returns its exit value. The notebook will run in the current livy session context by default.
notebookutils.notebook.update

Update a notebook
mssparkutils.runtime.context

Get runtime properties
mssparkutils.notebook.validateDAG

Check if the DAG is correctly defined, if the syntax is correct, and if notebooks are found in the workspace without actual execution. Details can be found in mssparkutils.notebook.help("validateDAG").
mssparkutils.credentials.isValidToken

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

Gets the local path of the mount point.
mssparkutils.lakehouse.update

Update a lakehouse
notebookutils.variableLibrary.get

Get a variable value
notebookutils.udf.run

Run a User data functions (UDF).
mssparkutils.fs.unmountFromDriverNode

Removes a mount point from driver node.
mssparkutils.fs.getMountPath

Gets the local path of the mount point.
mssparkutils.fs.fastcp

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

Gets the local path of the notebook resource.
mssparkutils.help

Get help message for this module.
notebookutils.credentials.getSecretWithLS

Return AKV secret using linkedService.
mssparkutils.notebook.runMultiple

Runs multiple notebooks concurrently with support for dependency relationships. Details can be found in mssparkutils.notebook.help("runMultiple").
mssparkutils.notebook.updateNBSEndpoint

provide a way to make people can update the endpoint
mssparkutils.fs.cp

Copies a file or directory, possibly across FileSystems.
mssparkutils.fs.rm

Removes a file or directory.
mssparkutils.fs.exists

Check if a file or directory exists.
notebookutils.credentials.getToken

Get AAD token for a resource.
mssparkutils.fs.unmount

Removes a mount point.
notebookutils.connections.getHelpString

Get help string for a method.
notebookutils.connections.getCredential

Get credential for a connection
notebookutils.credentials.getConnectionStringOrCreds

Take linked service name as input and return connection string or credentials depending on the configuration of the linked service.
mssparkutils.notebook.exit

This method lets you exit a notebook with a value.
notebookutils.env.getUserName

Get user name.
notebookutils.env.help

Get help message.
notebookutils.fs.cp

Copies a file or directory, possibly across FileSystems.
notebookutils.env.getWorkspaceName

Get workspace name.
notebookutils.fs.append

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

Refresh workspace level mount points.
notebookutils.fs.head

Returns up to the first 'maxBytes' bytes of the given file as a String encoded in UTF-8.
notebookutils.fs.exists

Check if a file or directory exists.
notebookutils.fabricClient.delete

Send a DELETE request to Fabric.
notebookutils.credentials.getFullConnectionString

Take linked service name as input and return full connection string with credentials.
notebookutils.fs.help

notebookutils.fs provides utilities for working with various FileSystems.
notebookutils.fs.ls

Lists the contents of a directory.
notebookutils.conf.get

Get a config value
notebookutils.credentials.putSecret

Put AKV secret using with or without linkedService.
notebookutils.help

Get help message for this module.
notebookutils.initialize

Initialize notebookutils, using in pre-run code
notebookutils.notebook.exit

This method lets you exit a notebook with a value.
notebookutils.fs.rm

Removes a file or directory.
notebookutils.conf.set

Set a config key/value
notebookutils.lakehouse.getWithProperties

Get the info of a Lakehouse with properties.
notebookutils.fs.mount

Attach remote storage (Blob, Gen2, Azure File Share) to all working nodes (driver node and worker nodes)
notebookutils.fs.mkdirs

Creates the given directory if it does not exist, also creating any necessary parent * directories.
notebookutils.fs.fastcp

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

The lakehouse module.
notebookutils.lakehouse.listTables

List all tables in a Lakehouse.
notebookutils.lakehouse.list

List all lakehouses
notebookutils.notebook.get

Get a notebook
notebookutils.fabricClient.get

Send a GET request to Fabric.
notebookutils.credentials.putSecretWithLS

Put AKV secret using linkedService.
notebookutils.fabricClient.help

Get help string for a method.
notebookutils.fs.mountToDriverNode

Attach remote storage (Blob, Gen2, Azure File Share) to driver node
notebookutils.runtime.context

Get runtime properties
notebookutils.notebook.validateDAG

Check if the DAG is correctly defined, if the syntax is correct, and if notebooks are found in the workspace without actual execution. Details can be found in mssparkutils.notebook.help("validateDAG").
notebookutils.env.getClusterId

Get cluster id.
notebookutils.udf.getHelpString

Get help string for a method.
notebookutils.udf.help

Get help string for a method.
notebookutils.lakehouse.updateDefinition

Get the definition of a lakehouse
notebookutils.lakehouse.getDefinition

Get the definition of a lakehouse
notebookutils.lakehouse.get

Get a lakehouse
notebookutils.lakehouse.delete

Delete a lakehouse
notebookutils.udf.getFunctions

Get UDF functions metadata.
notebookutils.notebook.help

The notebook module.
notebookutils.lakehouse.create

Create a lakehouse
notebookutils.session.stop

Stop an interactive session
notebookutils.fs.mounts

Show information about what is mounted. Any credentials used to mount the mount points listed will not be displayed.
notebookutils.notebook.list

List all notebooks
notebookutils.env.getJobId

Get job Id.
notebookutils.notebook.updateNBSEndpoint

provide a way to make people can update the endpoint
notebookutils.notebook.updateDefinition

Get the definition of a notebook
notebookutils.nbResPath

Gets the local path of the notebook resource.
notebookutils.runtime.help

notebookutils.runtime is a utility to manage runtime context. context() returns the runtime context as a list.
notebookutils.runtime.setHcReplId

Set runtime high concurrency mode repl id
notebookutils.variableLibrary.getLibrary

Get a variable library
notebookutils.variableLibrary.getHelpString

Get help string for a method.
notebookutils.fabricClient.post

Send a POST request to Fabric.
notebookutils.fabricClient.put

Send a PUT request to Fabric.
notebookutils.fs.put

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

Starts a load table operation.
notebookutils.fs.mv

Moves a file or directory, possibly across FileSystems. For intra-FileSystem, it is implemented by hadoop fs rename operation. For inter-FileSystem, This is implemented as a copy followed by delete.
notebookutils.lakehouse.update

Update a lakehouse
mssparkutils.credentials.getSecret

Return AKV secret.
mssparkutils.credentials.getPropertiesAll

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

Take linked service name as input and return connection string or credentials depending on the configuration of the linked service.
display

Set the dataframe info which needs to be visualized.
display.config

Set the chart config metadata for current dataframe (set by display) which needs to be visualized.
mssparkutils.credentials.getSecretWithLS

Return AKV secret using linkedService.
mssparkutils.credentials.getToken

Get AAD token for a resource.
mssparkutils.env.getPoolName

Get pool name.