SparkClientContext class

Package:
@azure/synapse-spark
Extends
ServiceClient

Constructors

SparkClientContext(TokenCredential, string, string, SparkClientOptionalParams)

Initializes a new instance of the SparkClientContext class.

Properties

endpoint
livyApiVersion
sparkPoolName

Inherited Properties

pipeline

The pipeline used by this client to make requests

Inherited Methods

sendOperationRequest<T>(OperationArguments, OperationSpec)

Send an HTTP request that is populated using the provided OperationSpec.
sendRequest(PipelineRequest)

Send the provided httpRequest.

Constructor Details

SparkClientContext(TokenCredential, string, string, SparkClientOptionalParams)

Initializes a new instance of the SparkClientContext class.

new SparkClientContext(credentials: TokenCredential, endpoint: string, sparkPoolName: string, options?: SparkClientOptionalParams)

Parameters

credentials
TokenCredential

Subscription credentials which uniquely identify client subscription.

endpoint

string

The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.

sparkPoolName

string

Name of the spark pool.

options
SparkClientOptionalParams

The parameter options

Property Details

endpoint 

endpoint: string

Property Value

string

livyApiVersion 

livyApiVersion: string

Property Value

string

sparkPoolName 

sparkPoolName: string

Property Value

string

Inherited Property Details

pipeline

The pipeline used by this client to make requests

pipeline: Pipeline

Property Value

Pipeline

Inherited From coreClient.ServiceClient.pipeline

Inherited Method Details

sendOperationRequest<T>(OperationArguments, OperationSpec)

Send an HTTP request that is populated using the provided OperationSpec.

function sendOperationRequest<T>(operationArguments: OperationArguments, operationSpec: OperationSpec): Promise<T>

Parameters

operationArguments
OperationArguments

The arguments that the HTTP request's templated values will be populated from.

operationSpec
OperationSpec

The OperationSpec to use to populate the httpRequest.

Returns

Promise<T>

Inherited From coreClient.ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Send the provided httpRequest.

function sendRequest(request: PipelineRequest): Promise<PipelineResponse>

Parameters

request
PipelineRequest

Returns

Promise<PipelineResponse>

Inherited From coreClient.ServiceClient.sendRequest