Get-AzSynapseSparkSession
Gets a Synapse Analytics Spark session.
Syntax
GetByNameParameterSet (Default)
Get-AzSynapseSparkSession
-WorkspaceName <String>
-SparkPoolName <String>
[-LivyId <Int32>]
[-Name <String>]
[-ApplicationId <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByParentObjectParameterSet
Get-AzSynapseSparkSession
-SparkPoolObject <PSSynapseSparkPool>
[-LivyId <Int32>]
[-Name <String>]
[-ApplicationId <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzSynapseSparkSession cmdlet gets information about an Azure Synapse Analytics Spark session.
Examples
Example 1
Get-AzSynapseSparkSession -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool
This command gets all the Spark sessions under the specified Spark pool.
Example 2
Get-AzSynapseSparkSession -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -LivyId 1
This command gets the Spark session with the specified livy ID.
Example 3
$pool = Get-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool
$pool | Get-AzSynapseSparkSession
This command gets all the Spark sessions under the specified Spark pool through pipeline.
Parameters
-ApplicationId
The Application identifier of the session.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-LivyId
Identifier of Spark session.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False Aliases: Id
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
Name of Synapse Spark pool.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SparkPoolName
Name of Synapse Spark pool.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
GetByNameParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SparkPoolObject
Spark pool input object, usually passed through the pipeline.
Parameter properties
Parameter sets
GetByParentObjectParameterSet
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-WorkspaceName
Name of Synapse workspace.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
GetByNameParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
