Get-AzSynapseSparkJob
Gets a Synapse Analytics Spark job.
Syntax
Get-AzSynapseSparkJob
-WorkspaceName <String>
-SparkPoolName <String>
[-LivyId <Int32>]
[-Name <String>]
[-ApplicationId <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzSynapseSparkJob
-SparkPoolObject <PSSynapseSparkPool>
[-LivyId <Int32>]
[-Name <String>]
[-ApplicationId <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
The Get-AzSynapseSparkJob cmdlet gets an Azure Synapse Analytics Spark job. If you do not specify a job, this cmdlet gets all jobs.
Examples
Example 1
Get-AzSynapseSparkJob -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPoolThis command gets all jobs under a Spark pool.
Example 2
Get-AzSynapseSparkJob -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -LivyId 119This command gets the job with the specified ID.
Example 3
Get-AzSynapseSparkJob -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -ApplicationId application_1585023543211_0004This command gets the job with the specified application ID.
Example 4
$pool = Get-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool
$pool | Get-AzSynapseSparkJobThis command gets all jobs under a 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 job.
| Type: | Int32 |
| Aliases: | Id |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Name of Spark job.
| 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 |