Export-AzSynapseSparkConfiguration
Exports a Synapse spark configuration to an output folder.
Syntax
Export-AzSynapseSparkConfiguration
-WorkspaceName <String>
[-Name <String>]
-OutputFolder <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Export-AzSynapseSparkConfiguration
-WorkspaceObject <PSSynapseWorkspace>
[-Name <String>]
-OutputFolder <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Export-AzSynapseSparkConfiguration
-InputObject <PSSparkConfigurationResource>
-OutputFolder <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
The Export-AzSynapseSparkConfiguration cmdlet exports a Synapse spark configuration to a configuration(.json) file. The name of the spark configuration becomes the name of the exported file. If you specify the name of a spark configuration, the cmdlet exports that spark configuration. If you do not specify a name, the cmdlet export all spark configurations in the workspace.
Examples
Example 1
Export-AzSynapseSparkConfiguration -WorkspaceName ContosoWorkspace -OutputFolder "C:\SparkConfiguration"Exports all spark configurations in the workspace ContosoWorkspace to the folder "C:\SparkConfiguration".
Example 2
Export-AzSynapseSparkConfiguration -WorkspaceName ContosoWorkspace -Name ContoSparkConfiguration -OutputFolder "C:\SparkConfiguration"Exports a single spark configuration named ContoSparkConfiguration in the workspace ContosoWorkspace to the folder "C:\SparkConfiguration".
Example 3
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Export-AzSynapseSparkConfiguration -Name ContoSparkConfiguration -OutputFolder "C:\SparkConfiguration"Exports a single spark configuration named ContoSparkConfiguration in the workspace ContosoWorkspace to the folder "C:\SparkConfiguration" through pipeline.
Example 4
$sparkConfiguration = Get-AzSynapseSparkConfiguration -WorkspaceName ContosoWorkspace -Name ContoSparkConfiguration
$sparkConfiguration | Export-AzSynapseSparkConfiguration -OutputFolder "C:\SparkConfiguration"Exports a single spark configuration called ContoSparkConfiguration in the workspace ContosoWorkspace to the folder "C:\SparkConfiguration" 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 Spark configuration object.
| Type: | PSSparkConfigurationResource |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
The Spark Configuration name.
| Type: | String |
| Aliases: | SparkConfigurationName |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OutputFolder
The folder where the spark configuration 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
Outputs
Azure PowerShell