Share via


@azure/synapse package

Classes

Monitoring

Class representing a Monitoring.

SparkBatch

Class representing a SparkBatch.

SparkSession

Class representing a SparkSession.

SynapseClient
SynapseClientContext
WorkspaceAcl

Class representing a WorkspaceAcl.

Interfaces

BaseResource
CloudError
Config

An interface representing Config.

Data

An interface representing Data.

Edge

An interface representing Edge.

ErrorDetail

An interface representing ErrorDetail.

ErrorInformation

An interface representing ErrorInformation.

ErrorResponse

An interface representing ErrorResponse.

Executors

An interface representing Executors.

ExtendedLivyBatchRequest

An interface representing ExtendedLivyBatchRequest.

ExtendedLivyBatchResponse

An interface representing ExtendedLivyBatchResponse.

ExtendedLivyListBatchResponse

An interface representing ExtendedLivyListBatchResponse.

ExtendedLivyListSessionResponse

An interface representing ExtendedLivyListSessionResponse.

ExtendedLivySessionRequest

An interface representing ExtendedLivySessionRequest.

ExtendedLivySessionResponse

An interface representing ExtendedLivySessionResponse.

GetAccessControlInfoRequest

An interface representing GetAccessControlInfoRequest.

HistoryServerDataResponse

An interface representing HistoryServerDataResponse.

HistoryServerDiagnosticResponse

An interface representing HistoryServerDiagnosticResponse.

HistoryServerDiagnosticResponseData

An interface representing HistoryServerDiagnosticResponseData.

HistoryServerGraphResponse

An interface representing HistoryServerGraphResponse.

HistoryServerGraphResponseData

An interface representing HistoryServerGraphResponseData.

HistoryServerPropertiesResponse

An interface representing HistoryServerPropertiesResponse.

Jobs

An interface representing Jobs.

LivyBatchStateInformation

An interface representing LivyBatchStateInformation.

LivyRequestBase

An interface representing LivyRequestBase.

LivySessionStateInformation

An interface representing LivySessionStateInformation.

LivyStatementCancellationResponse

An interface representing LivyStatementCancellationResponse.

LivyStatementOutput

An interface representing LivyStatementOutput.

LivyStatementRequestBody

An interface representing LivyStatementRequestBody.

LivyStatementResponseBody

An interface representing LivyStatementResponseBody.

LivyStatementsResponseBody

An interface representing LivyStatementsResponseBody.

Option

An interface representing Option.

SchedulerInformation

An interface representing SchedulerInformation.

SetWorkspaceAdministratorsRequest

An interface representing SetWorkspaceAdministratorsRequest.

SparkBatchCreateOptionalParams

Optional Parameters.

SparkBatchGetOptionalParams

Optional Parameters.

SparkBatchListOptionalParams

Optional Parameters.

SparkJob

An interface representing SparkJob.

SparkJobListViewResponse

An interface representing SparkJobListViewResponse.

SparkServicePluginInformation

An interface representing SparkServicePluginInformation.

SparkSessionCreateOptionalParams

Optional Parameters.

SparkSessionGetOptionalParams

Optional Parameters.

SparkSessionListOptionalParams

Optional Parameters.

Stages

An interface representing Stages.

SynapseClientOptions

An interface representing SynapseClientOptions.

Tables

An interface representing Tables.

WorkspaceAccessControlResponse

An interface representing WorkspaceAccessControlResponse.

Type Aliases

ArtifactType

Defines values for ArtifactType. Possible values include: 'Workspace'

ErrorSource

Defines values for ErrorSource. Possible values include: 'System', 'User', 'Unknown', 'Dependency'

JobResult

Defines values for JobResult. Possible values include: 'Uncertain', 'Succeeded', 'Failed', 'Cancelled'

JobType

Defines values for JobType. Possible values include: 'SparkBatch', 'SparkSession'

MonitoringGetApplicationDetailsResponse

Contains response data for the getApplicationDetails operation.

MonitoringGetHistoryServerDataResponse

Contains response data for the getHistoryServerData operation.

MonitoringGetHistoryServerDiagnosticResponse

Contains response data for the getHistoryServerDiagnostic operation.

MonitoringGetHistoryServerGraphResponse

Contains response data for the getHistoryServerGraph operation.

MonitoringGetHistoryServerPropertiesResponse

Contains response data for the getHistoryServerProperties operation.

MonitoringGetSparkJobListResponse

Contains response data for the getSparkJobList operation.

PluginCurrentState

Defines values for PluginCurrentState. Possible values include: 'Preparation', 'ResourceAcquisition', 'Queued', 'Submission', 'Monitoring', 'Cleanup', 'Ended'

SchedulerCurrentState

Defines values for SchedulerCurrentState. Possible values include: 'Queued', 'Scheduled', 'Ended'

SparkBatchCreateResponse

Contains response data for the create operation.

SparkBatchGetResponse

Contains response data for the get operation.

SparkBatchListResponse

Contains response data for the list operation.

SparkSessionCreateResponse

Contains response data for the create operation.

SparkSessionCreateStatementResponse

Contains response data for the createStatement operation.

SparkSessionDeleteStatementResponse

Contains response data for the deleteStatement operation.

SparkSessionGetResponse

Contains response data for the get operation.

SparkSessionGetStatementResponse

Contains response data for the getStatement operation.

SparkSessionListResponse

Contains response data for the list operation.

SparkSessionListStatementsResponse

Contains response data for the listStatements operation.

WorkspaceAclGetAccessControlInfoResponse

Contains response data for the getAccessControlInfo operation.

WorkspaceAclSetWorkspaceAdministratorsResponse

Contains response data for the setWorkspaceAdministrators operation.