Reset-AzSynapseSparkSessionTimeout

Module:

Az.Synapse

Resets timeout of a Synapse Analytics Spark session.

Syntax

Reset-AzSynapseSparkSessionTimeout
     -WorkspaceName <String>
     -SparkPoolName <String>
     -LivyId <Int32>
     [-PassThru]
     [-AsJob]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Reset-AzSynapseSparkSessionTimeout
     -LivyId <Int32>
     -SparkPoolObject <PSSynapseSparkPool>
     [-PassThru]
     [-AsJob]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Reset-AzSynapseSparkSessionTimeout
     -InputObject <PSSynapseSparkSession>
     [-PassThru]
     [-AsJob]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

The Remove-AzSynapseSparkSessionTimeout cmdlet resets timeout of a Synapse Analytics Spark session.

Examples

Example 1

Reset-AzSynapseSparkSessionTimeout -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -LivyId 125

This command resets timeout of the Synapse Analytics Spark session with the specified livy ID.

Example 2

$pool = Get-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool
$pool | Reset-AzSynapseSparkSessionTimeout -LivyId 125

This command resets timeout of the Synapse Analytics Spark session with the specified livy ID through pipeline.

Example 3

$session = Get-AzSynapseSparkSession -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -LivyId 125
$session | Reset-AzSynapseSparkSessionTimeout

This command resets timeout of the Synapse Analytics Spark session with the specified livy ID through pipeline.

Parameters

-AsJob

Run cmdlet in the background

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-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

-InputObject

Spark session input object, usually passed through the pipeline.

Type:	PSSynapseSparkSession
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-LivyId

Identifier of Spark session.

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

-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

PSSynapseSparkSession

Outputs

Boolean