| external help file | Module Name | online version | schema |
|---|---|---|---|
Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml |
Az.Synapse |
2.0.0 |
Exports notbooks.
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>]
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.
Export-AzSynapseNotebook -WorkspaceName ContosoWorkspace -OutputFolder "C:\Notebook"Exports all notebooks in the workspace ContosoWorkspace to the folder "C:\Notebook".
Export-AzSynapseNotebook -WorkspaceName ContosoWorkspace -Name ContosoNotebook -OutputFolder "C:\Notebook"Exports a single notebook called ContosoNotebook in the workspace ContosoWorkspace to the folder "C:\Notebook".
$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.
$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.
Run cmdlet in the background
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe credentials, account, tenant, and subscription used for communication with Azure.
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe notebook object.
Type: Microsoft.Azure.Commands.Synapse.Models.PSNotebookResource
Parameter Sets: ExportByInputObject
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseThe notebook name.
Type: System.String
Parameter Sets: ExportByName, ExportByObject
Aliases: NotebookName
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe folder where the notebook should be placed.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseName of Synapse workspace.
Type: System.String
Parameter Sets: ExportByName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: Falseworkspace input object, usually passed through the pipeline.
Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace
Parameter Sets: ExportByObject
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.