Share via

SparkSessionClient.GetSparkSessionAsync Method

  • Reference

Definition

Namespace:
Azure.Analytics.Synapse.Spark
Assembly:
Azure.Analytics.Synapse.Spark.dll
Package:
Azure.Analytics.Synapse.Spark v1.0.0-preview.8
Source:
SparkSessionClient.cs

Gets a single spark session.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Synapse.Spark.Models.SparkSession>> GetSparkSessionAsync (int sessionId, bool? detailed = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetSparkSessionAsync : int * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Synapse.Spark.Models.SparkSession>>
override this.GetSparkSessionAsync : int * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Synapse.Spark.Models.SparkSession>>
Public Overridable Function GetSparkSessionAsync (sessionId As Integer, Optional detailed As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SparkSession))

Parameters

sessionId
Int32

Identifier for the session.

detailed
Nullable<Boolean>

Optional query param specifying whether detailed response is returned beyond plain livy.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Task<Response<SparkSession>>

Applies to