Get-AzSynapseSparkSession

Reference

Module:: Az.Synapse

Gets a Synapse Analytics Spark session.

Syntax

Get-AzSynapseSparkSession
   -WorkspaceName <String>
   -SparkPoolName <String>
   [-LivyId <Int32>]
   [-Name <String>]
   [-ApplicationId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

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.

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

-LivyId

Identifier of Spark session.

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

-Name

Name of Synapse Spark pool.

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

-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

Freigeben über