Get-AzSynapseSparkStatement
Gets a Synapse Analytics Spark statement.
Syntax
Get-AzSynapseSparkStatement
-WorkspaceName <String>
-SparkPoolName <String>
[-LivyId <Int32>]
-SessionId <Int32>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzSynapseSparkStatement
-SessionObject <PSSynapseSparkSession>
[-LivyId <Int32>]
[-SessionId <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
The Get-AzSynapseSparkStatement cmdlet gets information about an Azure Synapse Analytics Spark statement.
Examples
Example 1
Get-AzSynapseSparkStatement -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -SessionId 120This command gets all the Spark statements under a Spark session.
Example 2
Get-AzSynapseSparkStatement -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -SessionId 120 -LivyId 0This command gets the Spark statement with the specified livy ID.
Example 3
$session = Get-AzSynapseSparkSession -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -LivyId 107
$session | Get-AzSynapseSparkStatementThis command gets all the Spark statements under a Spark session through pipeline.
Parameters
-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 statement.
| Type: | Int32 |
| Aliases: | Id |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SessionId
Identifier of Spark session.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SessionObject
Spark pool input object, usually passed through the pipeline.
| Type: | PSSynapseSparkSession |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| 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 |
-WorkspaceName
Name of Synapse workspace.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
