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


[Up] [Top]

Documentation for package ‘notebookutils’ version 1.5.1

Help Pages

display Set the dataframe info which needs to be visualized.
displayHTML notebook.R: Utility for visualization Construct an specific html fragment to synapse notebook front-end for rendering based on user-input html content.
mssparkutils.credentials.getConnectionStringOrCreds Take linked service name as input and return connection string or credentials depending on the configuration of the linked service.
mssparkutils.credentials.getFullConnectionString Take linked service name as input and return full connection string with credentials.
mssparkutils.credentials.getPropertiesAll Return all the properties of a given linked service in string format.
mssparkutils.credentials.getSecret Return AKV secret.
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.
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.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 encoded in UTF-8.
mssparkutils.fs.help mssparkutils.fs provides utilities for working with various FileSystems.
mssparkutils.fs.ls Lists the contents of a directory.
mssparkutils.fs.mkdirs Creates the given directory if it does not exist, also creating any necessary parent * directories. Attach remote storage (Blob, Gen2, Azure File Share) to all working nodes (driver node and worker nodes)
mssparkutils.fs.mount Attach remote storage (Blob, Gen2, Azure File Share) to all working nodes (driver node and worker nodes)
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.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.help Get help message for this module.
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 the current livy session context by default.
mssparkutils.runtime.context Get runtime properties