Start-AzSynapseSparkSession

Reference

Module:: Az.Synapse

Starts a Synapse Analytics Spark session.

Syntax

Start-AzSynapseSparkSession
     -WorkspaceName <String>
     -SparkPoolName <String>
     [-Language <String>]
     -Name <String>
     [-ReferenceFile <String[]>]
     -ExecutorCount <Int32>
     -ExecutorSize <String>
     [-Configuration <Hashtable>]
     [-AsJob]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Start-AzSynapseSparkSession
     -SparkPoolObject <PSSynapseSparkPool>
     [-Language <String>]
     -Name <String>
     [-ReferenceFile <String[]>]
     -ExecutorCount <Int32>
     -ExecutorSize <String>
     [-Configuration <Hashtable>]
     [-AsJob]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

The Start-AzSynapseSparkSession cmdlet starts a Synapse Analytics Spark session.

Examples

Example 1

Start-AzSynapseSparkSession -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -Name ContosoSessionName -ExecutorCount 3 -ExecutorSize Small

This command starts an Azure Synapse Analytics Spark session.

Example 2

$pool = Get-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool
$pool | Start-AzSynapseSparkSession -Name ContosoSessionName -ExecutorCount 3 -ExecutorSize Small

This command starts an Azure Synapse Analytics Spark session 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

-Configuration

Spark configuration properties.

Type:	Hashtable
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

-ExecutorCount

Number of executors to be allocated in the specified Spark pool for the job.

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

-ExecutorSize

Number of core and memory to be used for executors allocated in the specified Spark pool for the job.

Type:	String
Accepted values:	Small, Medium, Large, XLarge, XXLarge, XXXLarge
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Language

Language of the execution code.

Type:	String
Accepted values:	Spark, Scala, PySpark, Python, SparkDotNet, CSharp, SQL
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Name of Spark session.

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

-ReferenceFile

Additional files used for reference in the main definition file. Comma-separated storage URI list. e.g. "abfss://filesystem@account.dfs.core.windows.net/file1.txt,abfss://filesystem@account.dfs.core.windows.net/result/"

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

-SparkPoolName

Name of Synapse Spark pool.

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

-SparkPoolObject

Spark pool input object, usually passed through the pipeline.

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

Inputs

PSSynapseSparkPool

Outputs

PSSynapseSparkSession