Get-AzureDatabricksNotebook

NAME Get-AzureDatabricksNotebook



SYNOPSIS

Returns an array of objects representing saved notebooks in an Azure Databricks instance.





SYNTAX

Get-AzureDatabricksNotebook [-Connection] <Object> [[-Path] <String>] [[-NotebookName] <String>]

[<CommonParameters>]





DESCRIPTION

Returns an array of objects representing saved notebooks in an Azure Databricks instance. Each object contains the

name of the saved Notebook as well as the absolute path

in the Databricks instance that the Notebook is saved in. Note: this function is NOT recursive and paths ARE case

senstiive!





PARAMETERS

-Connection <Object>

An object that represents an Azure Databricks API connection where you want to get a list of job runs from.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Path <String>

The path to scan for Notebooks. Defaults to the root of the instance workspace.



Required? false

Position? 2

Default value /

Accept pipeline input? false

Accept wildcard characters? false



-NotebookName <String>

The name of the notebook to filter on, if any.



Required? false

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES





Author: Drew Furgiuele (@pittfurg), http://www.port1433.com

Website: https://www.igs.com

Copyright: (c) 2019 by IGS, licensed under MIT

License: MIT https://opensource.org/licenses/MIT



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get-AzureDatabricksNotebook -Connection $Connection



Returns an array of notebook objects that contain the file name and path to the notebook in the root (/) directory

on the Databricks instance.









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-AzureDatabricksNotebook -Connection $Connection -Path "/User/Drew"



Returns an array of notebook objects that contain the file name and path to the notebook in the "/User/Drew"

directory on the Databricks instance.









-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Get-AzureDatabricksNotebook -Connection $Connection -NotebookName "DrewsNotebook"



Returns an array of notebook objects that contain the file name in the root directory on the Databricks instance

named "DrewsNotebook"











RELATED LINKS