Wait-AzSynapseSparkJob
Waits for a Synapse Analytics Spark job to complete.
Syntax
Wait-AzSynapseSparkJob
-WorkspaceName <String>
-SparkPoolName <String>
-LivyId <Int32>
[-WaitIntervalInSeconds <Int32>]
[-TimeoutInSeconds <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Wait-AzSynapseSparkJob
-SparkPoolObject <PSSynapseSparkPool>
-LivyId <Int32>
[-WaitIntervalInSeconds <Int32>]
[-TimeoutInSeconds <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Wait-AzSynapseSparkJob
-SparkJobObject <PSSynapseSparkJob>
[-LivyId <Int32>]
[-WaitIntervalInSeconds <Int32>]
[-TimeoutInSeconds <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
The Wait-AzSynapseSparkJob cmdlet waits for an Azure Synapse Analytics job to complete.
Examples
Example 1
Wait-AzSynapseSparkJob -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -LivyId 324This command waits for the job with the specified ID to complete.
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 job.
| Type: | Int32 |
| Aliases: | Id |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SparkJobObject
Spark job input object, usually passed through the pipeline.
| Type: | PSSynapseSparkJob |
| 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 |
-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 |
-TimeoutInSeconds
The maximum amount of time to wait before erroring out. Default value is to never timeout.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WaitIntervalInSeconds
The polling interval between checks for the job status, in seconds.
| Type: | Int32 |
| 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 |
