New-AzSynapseSparkConfiguration

Reference

Module:: Az.Synapse

Creates or updates a spark configuration in a workspace.

Syntax

New-AzSynapseSparkConfiguration
   -WorkspaceName <String>
   [-Name <String>]
   -DefinitionFile <String>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzSynapseSparkConfiguration
   -WorkspaceObject <PSSynapseWorkspace>
   [-Name <String>]
   -DefinitionFile <String>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-AzSynapseSparkConfiguration cmdlet creates or updates a spark configuration in a workspace. If you specify the name of a spark configuration, the new spark configuration will be named as the specified one, if you don't specify the name, the new spark configuration will be the same name as the definition file.

Examples

Example 1

New-AzSynapseSparkConfiguration -WorkspaceName ContosoWorkspace -DefinitionFile "C:\\samples\\sparkconfiguration.json"

This command creates or updates a spark configuration from file sparkconfiguration.json in the workspace named ContosoWorkspace.

Example 2

New-AzSynapseSparkConfiguration -WorkspaceName ContosoWorkspace -Name ContosoSparkConfiguration -DefinitionFile "C:\\samples\\sparkconfiguration.json"

This command creates or updates a spark configuration named ContosoSparkConfiguration from file sparkconfiguration.json in the workspace named ContosoWorkspace.

Example 3

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | New-AzSynapseSparkConfiguration -DefinitionFile "C:\\samples\\sparkconfiguration.json"

This command creates or updates a spark configuration from file sparkconfiguration.json in the workspace named ContosoWorkspace 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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
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

-DefinitionFile

The JSON file path.

Type:	String
Aliases:	File
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
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

Outputs

PSSparkConfigurationResource