Export-AzSynapseNotebook

  • Reference
Module:
Az.Synapse

Exports notbooks.

Syntax

Export-AzSynapseNotebook
      -WorkspaceName <String>
      [-Name <String>]
      -OutputFolder <String>
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [<CommonParameters>]
Export-AzSynapseNotebook
      -WorkspaceObject <PSSynapseWorkspace>
      [-Name <String>]
      -OutputFolder <String>
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [<CommonParameters>]
Export-AzSynapseNotebook
      -InputObject <PSNotebookResource>
      -OutputFolder <String>
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [<CommonParameters>]

Description

The Export-AzSynapseNotebook cmdlet exports an Azure Synapse notebook to a notebook (.ipynb) file. The name of the notebook becomes the name of the exported file. If you specify the name of a notebook, the cmdlet exports that notebook. If you do not specify a name, the cmdlet export all notebooks in the workspace.

Examples

Example 1

Export-AzSynapseNotebook -WorkspaceName ContosoWorkspace -OutputFolder "C:\Notebook"

Exports all notebooks in the workspace ContosoWorkspace to the folder "C:\Notebook".

Example 2

Export-AzSynapseNotebook -WorkspaceName ContosoWorkspace -Name ContosoNotebook -OutputFolder "C:\Notebook"

Exports a single notebook called ContosoNotebook in the workspace ContosoWorkspace to the folder "C:\Notebook".

Example 3

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Export-AzSynapseNotebook -Name ContosoNotebook -OutputFolder "C:\Notebook"

Exports a single notebook called ContosoNotebook in the workspace ContosoWorkspace to the folder "C:\Notebook" through pipeline.

Example 4

$notebook = Get-AzSynapseNotebook -WorkspaceName ContosoWorkspace -Name ContosoNotebook
$notebook | Export-AzSynapseNotebook -OutputFolder "C:\Notebook"

Exports a single notebook called ContosoNotebook in the workspace ContosoWorkspace to the folder "C:\Notebook" through pipeline.

Parameters

-AsJob

Run cmdlet in the background

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

The notebook object.

Type:PSNotebookResource
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

The notebook name.

Type:String
Aliases:NotebookName
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OutputFolder

The folder where the notebook should be placed.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WorkspaceName

Name of Synapse workspace.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WorkspaceObject

workspace input object, usually passed through the pipeline.

Type:PSSynapseWorkspace
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

PSSynapseWorkspace

PSNotebookResource

Outputs

FileInfo