Wait-AzSynapseSparkJob

Module:

Az.Synapse Module

Waits for a Synapse Analytics Spark job to complete.

Syntax

WaitSparkJobByIdParameterSet (Default)

Wait-AzSynapseSparkJob
    -WorkspaceName <String>
    -SparkPoolName <String>
    -LivyId <Int32>
    [-WaitIntervalInSeconds <Int32>]
    [-TimeoutInSeconds <Int32>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

WaitSparkJobByIdFromParentObjectParameterSet

Wait-AzSynapseSparkJob
    -SparkPoolObject <PSSynapseSparkPool>
    -LivyId <Int32>
    [-WaitIntervalInSeconds <Int32>]
    [-TimeoutInSeconds <Int32>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

WaitSparkJobByIdFromInputObjectParameterSet

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 324

This command waits for the job with the specified ID to complete.

Parameters

-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 job.

Parameter properties

Type:	Int32
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	Id

Parameter sets

WaitSparkJobByIdParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

WaitSparkJobByIdFromParentObjectParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SparkJobObject

Spark job input object, usually passed through the pipeline.

Parameter properties

Type:	PSSynapseSparkJob
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

WaitSparkJobByIdFromInputObjectParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	True
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

WaitSparkJobByIdParameterSet

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

Type:	PSSynapseSparkPool
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

WaitSparkJobByIdFromParentObjectParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-TimeoutInSeconds

The maximum amount of time to wait before erroring out. Default value is to never timeout.

Parameter properties

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

-WaitIntervalInSeconds

The polling interval between checks for the job status, in seconds.

Parameter properties

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

-WorkspaceName

Name of Synapse workspace.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

WaitSparkJobByIdParameterSet

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.

Inputs

PSSynapseSparkPool

PSSynapseSparkJob

Outputs

Boolean