How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Azure Synapse Analytics SparkSession API

The SparkSession API from Azure Synapse Analytics — 4 operation(s) for sparksession.

Azure Synapse Analytics SparkSession API is one of 35 APIs that Azure Synapse Analytics publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 11 JSON Schema definitions.

Tagged areas include SparkSession. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 11 JSON Schemas.

This API exposes 7 operations across 4 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version 2019-11-01-preview.

Requests are made against a single base URL, https://{workspaceName}.dev.azuresynapse.net.

7 operations 4 paths 8 schemas 1 DELETE3 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2019-11-01-preview
Base URL
https://management.azure.com
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

Azure Synapse Analytics SparkSession API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (azure_auth) using the implicit flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

SparkSession 7
GET
/livyApi/versions/{sparkPoolName}/sessions
Azure Synapse Analytics List Spark sessions
SparkSession_GetSparkSessions 4 params → 200default
POST
/livyApi/versions/{sparkPoolName}/sessions
Azure Synapse Analytics Create a Spark session
SparkSession_CreateSparkSession 2 params body → 200default
GET
/livyApi/versions/{sparkPoolName}/sessions/{sessionId}
Azure Synapse Analytics Get a Spark session
SparkSession_GetSparkSession 3 params → 200default
DELETE
/livyApi/versions/{sparkPoolName}/sessions/{sessionId}
Azure Synapse Analytics Cancel a Spark session
SparkSession_CancelSparkSession 2 params → 200default
GET
/livyApi/versions/{sparkPoolName}/sessions/{sessionId}/statements
Azure Synapse Analytics List Spark session statements
SparkSession_GetSparkStatements 2 params → 200default
POST
/livyApi/versions/{sparkPoolName}/sessions/{sessionId}/statements
Azure Synapse Analytics Create a Spark statement
SparkSession_CreateSparkStatement 2 params body → 200default
POST
/livyApi/versions/{sparkPoolName}/sessions/{sessionId}/statements/{statementId}/cancel
Azure Synapse Analytics Cancel a Spark statement
SparkSession_CancelSparkStatement 3 params → 200default

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are SparkSession (10 properties), SparkSessionOptions (7 properties), SparkStatement (4 properties), SparkSessionCollection (3 properties). Each schema is shown below with its type and property counts.

ErrorResponse
object
1 property
SparkStatement
object
4 properties
SparkStatementCancellationResult
object
1 property
SparkStatementCollection
object
2 properties
SparkSession
object
10 properties
SparkSessionOptions
object
7 properties 1 required
SparkSessionCollection
object
3 properties
SparkStatementOptions
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-synapse-analytics-sparksession-api-openapi.yml Raw ↑

Other APIs Azure Synapse Analytics publishes across the network.

Azure Synapse Analytics AzureADOnlyAuthentications API
Azure Synapse Analytics BigDataPools API
Azure Synapse Analytics Credential API
Azure Synapse Analytics DataFlow API
Azure Synapse Analytics DataFlowDebugSession API
Azure Synapse Analytics Dataset API
Azure Synapse Analytics GitIntegration API
Azure Synapse Analytics IntegrationRuntimes API
Azure Synapse Analytics IpFirewallRules API
Azure Synapse Analytics Keys API
Azure Synapse Analytics KqlScripts API
Azure Synapse Analytics KustoPools API
Where this information came from

This is an independent, third-party profile of Azure Synapse Analytics SparkSession API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.