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


[Up] [Top]

Documentation for package ‘notebookutils’ version 1.5.3

Help Pages

D M N

-- D --

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.
displayHTML Construct an specific html fragment to synapse notebook front-end for rendering based on user-input html content.

-- M --

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.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 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.
mssparkutils.fs.mount Attach remote storage (Blob, Gen2, Azure File Share) to all working nodes (driver node and worker nodes)
mssparkutils.fs.mounts Show information about what is mounted. Any credentials used to mount the mount points listed will not be displayed.
mssparkutils.fs.mountToDriverNode Attach remote storage (Blob, Gen2, Azure File Share) to driver node
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.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.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.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.runtime.context Get runtime properties
mssparkutils.runtime.setHcReplId Set runtime high concurrency mode repl id
mssparkutils.session.stop Stop an interactive session

-- N --

notebookutils.credentials.getConnectionStringOrCreds Take linked service name as input and return connection string or credentials depending on the configuration of the linked service.
notebookutils.credentials.getFullConnectionString Take linked service name as input and return full connection string with credentials.
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 encoded in UTF-8.
notebookutils.fs.help notebookutils.fs provides utilities for working with various FileSystems.
notebookutils.fs.ls Lists the contents of a directory.
notebookutils.fs.mkdirs Creates the given directory if it does not exist, also creating any necessary parent * directories.
notebookutils.fs.mount Attach remote storage (Blob, Gen2, Azure File Share) to all working nodes (driver node and worker nodes)
notebookutils.fs.mounts Show information about what is mounted. Any credentials used to mount the mount points listed will not be displayed.
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-FileSystem, it is implemented by hadoop fs rename operation. For inter-FileSystem, This is implemented as a copy followed by delete.
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.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.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 the current livy session context by default.
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.runtime.context Get runtime properties
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.session.stop Stop an interactive session
notebookutils.warehouse.create Create a warehouse
notebookutils.warehouse.delete Delete a warehouse
notebookutils.warehouse.get Get a warehouse
notebookutils.warehouse.getDefinition Get the definition of a warehouse
notebookutils.warehouse.help The warehouse module.
notebookutils.warehouse.list List all warehouses
notebookutils.warehouse.update Update a warehouse
notebookutils.warehouse.updateDefinition Get the definition of a warehouse
notebookutils.workspace.assignToCapacity Assign a workspace to a capacity
notebookutils.workspace.create Create a workspace
notebookutils.workspace.delete Delete a workspace
notebookutils.workspace.get Get a workspace
notebookutils.workspace.help The workspace module.
notebookutils.workspace.list List all workspaces
notebookutils.workspace.listArtifacts List the specified artifacts in the workspace
notebookutils.workspace.unassignFromCapacity Unassign a workspace from a capacity
notebookutils.workspace.update Update a workspace