SparkSessionClient.GetSparkSessionsAsync Method

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

List all spark sessions which are running under a particular spark pool.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Synapse.Spark.Models.SparkSessionCollection>> GetSparkSessionsAsync (int? from = default, int? size = default, bool? detailed = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetSparkSessionsAsync : Nullable<int> * Nullable<int> * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Synapse.Spark.Models.SparkSessionCollection>>
override this.GetSparkSessionsAsync : Nullable<int> * Nullable<int> * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Synapse.Spark.Models.SparkSessionCollection>>

Public Overridable Function GetSparkSessionsAsync (Optional from As Nullable(Of Integer) = Nothing, Optional size As Nullable(Of Integer) = Nothing, Optional detailed As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SparkSessionCollection))

Parameters

from

Nullable<Int32>

Optional param specifying which index the list should begin from.

size

Nullable<Int32>

Optional param specifying the size of the returned list. By default it is 20 and that is the maximum.

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<SparkSessionCollection>>