Stop-AzSynapseSparkJob

Module:

Az.Synapse

Cancels a Synapse Analytics Spark job.

Syntax

Stop-AzSynapseSparkJob
    -WorkspaceName <String>
    -SparkPoolName <String>
    -LivyId <Int32>
    [-Force]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Stop-AzSynapseSparkJob
    -SparkPoolObject <PSSynapseSparkPool>
    -LivyId <Int32>
    [-Force]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Stop-AzSynapseSparkJob
    -SparkJobObject <PSSynapseSparkJob>
    [-LivyId <Int32>]
    [-Force]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Stop-AzSynapseSparkJob cmdlet cancels a Synapse Analytics Spark job.

Examples

Example 1

Stop-AzSynapseSparkJob -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -LivyId 130

This command cancels a Synapse Analytics Spark job.

Example 2

$pool = Get-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool
$pool | Stop-AzSynapseSparkJob -LivyId 130

This command cancels a Synapse Analytics Spark job through pipeline.

Example 3

$job = Get-AzSynapseSparkJob -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -LivyId 130
$job | Stop-AzSynapseSparkJob

This command cancels a Synapse Analytics Spark job through pipeline.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
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

-Force

Do not ask for confirmation.

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

-PassThru

This Cmdlet does not return an object by default. If this switch is specified, it returns true if successful.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
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

Inputs

PSSynapseSparkPool

PSSynapseSparkJob

Outputs

Boolean