Azure Synapse Analytics

Azure Synapse Analytics SparkSession API

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

Documentation GitHub OpenAPI

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/microsoft-azure-synapse-analytics-sparksession-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.1.0
info:
  title: Azure Synapse Analytics - Access Control AzureADOnlyAuthentications SparkSession API
  description: Manage role assignments, role definitions, and access control for Synapse workspace resources. Supports Synapse role-based access control for fine-grained permissions.
  version: '2020-12-01'
  contact:
    name: Microsoft Azure Support
    url: https://azure.microsoft.com/en-us/support/
  license:
    name: Microsoft
    url: https://azure.microsoft.com/en-us/support/legal/
servers:
- url: https://{workspaceName}.dev.azuresynapse.net
  description: Synapse Data Plane
  variables:
    workspaceName:
      description: The workspace name.
      default: myworkspace
security:
- azure_auth:
  - user_impersonation
tags:
- name: SparkSession
paths:
  /livyApi/versions/{sparkPoolName}/sessions:
    get:
      operationId: SparkSession_GetSparkSessions
      summary: Azure Synapse Analytics List Spark sessions
      description: List all Spark sessions running against the Spark pool.
      tags:
      - SparkSession
      parameters:
      - $ref: '#/components/parameters/SparkPoolNameParameter'
      - name: from
        in: query
        schema:
          type: integer
      - name: size
        in: query
        schema:
          type: integer
      - name: detailed
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: Successfully retrieved the list of sessions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SparkSessionCollection'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      operationId: SparkSession_CreateSparkSession
      summary: Azure Synapse Analytics Create a Spark session
      description: Create new Spark session.
      tags:
      - SparkSession
      parameters:
      - $ref: '#/components/parameters/SparkPoolNameParameter'
      - name: detailed
        in: query
        schema:
          type: boolean
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SparkSessionOptions'
      responses:
        '200':
          description: Successfully created the session.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SparkSession'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /livyApi/versions/{sparkPoolName}/sessions/{sessionId}:
    get:
      operationId: SparkSession_GetSparkSession
      summary: Azure Synapse Analytics Get a Spark session
      description: Gets a single Spark session.
      tags:
      - SparkSession
      parameters:
      - $ref: '#/components/parameters/SparkPoolNameParameter'
      - name: sessionId
        in: path
        required: true
        schema:
          type: integer
      - name: detailed
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: Successfully retrieved the session.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SparkSession'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      operationId: SparkSession_CancelSparkSession
      summary: Azure Synapse Analytics Cancel a Spark session
      description: Cancels a running Spark session.
      tags:
      - SparkSession
      parameters:
      - $ref: '#/components/parameters/SparkPoolNameParameter'
      - name: sessionId
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Successfully cancelled the session.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /livyApi/versions/{sparkPoolName}/sessions/{sessionId}/statements:
    get:
      operationId: SparkSession_GetSparkStatements
      summary: Azure Synapse Analytics List Spark session statements
      description: Gets a list of statements within a Spark session.
      tags:
      - SparkSession
      parameters:
      - $ref: '#/components/parameters/SparkPoolNameParameter'
      - name: sessionId
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Successfully retrieved the statements.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SparkStatementCollection'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      operationId: SparkSession_CreateSparkStatement
      summary: Azure Synapse Analytics Create a Spark statement
      description: Create a statement within a Spark session.
      tags:
      - SparkSession
      parameters:
      - $ref: '#/components/parameters/SparkPoolNameParameter'
      - name: sessionId
        in: path
        required: true
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SparkStatementOptions'
      responses:
        '200':
          description: Successfully created the statement.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SparkStatement'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /livyApi/versions/{sparkPoolName}/sessions/{sessionId}/statements/{statementId}/cancel:
    post:
      operationId: SparkSession_CancelSparkStatement
      summary: Azure Synapse Analytics Cancel a Spark statement
      description: Kill a statement within a session.
      tags:
      - SparkSession
      parameters:
      - $ref: '#/components/parameters/SparkPoolNameParameter'
      - name: sessionId
        in: path
        required: true
        schema:
          type: integer
      - name: statementId
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Successfully cancelled the statement.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SparkStatementCancellationResult'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    SparkStatementOptions:
      type: object
      properties:
        code:
          type: string
          description: The code to execute.
        kind:
          type: string
          description: The language of the code.
          enum:
          - spark
          - pyspark
          - dotnetspark
          - sql
    SparkStatementCollection:
      type: object
      properties:
        total:
          type: integer
        statements:
          type: array
          items:
            $ref: '#/components/schemas/SparkStatement'
    SparkStatementCancellationResult:
      type: object
      properties:
        msg:
          type: string
          description: The cancellation message.
    SparkSessionCollection:
      type: object
      properties:
        from:
          type: integer
        total:
          type: integer
        sessions:
          type: array
          items:
            $ref: '#/components/schemas/SparkSession'
    SparkSessionOptions:
      type: object
      required:
      - name
      properties:
        name:
          type: string
        driverMemory:
          type: string
        driverCores:
          type: integer
        executorMemory:
          type: string
        executorCores:
          type: integer
        executorCount:
          type: integer
        conf:
          type: object
          additionalProperties:
            type: string
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
    SparkStatement:
      type: object
      properties:
        id:
          type: integer
        code:
          type: string
        state:
          type: string
        output:
          type: object
          properties:
            status:
              type: string
            executionCount:
              type: integer
            data:
              type: object
    SparkSession:
      type: object
      properties:
        livyInfo:
          type: object
          properties:
            currentState:
              type: string
        name:
          type: string
        workspaceName:
          type: string
        sparkPoolName:
          type: string
        submitterName:
          type: string
        state:
          type: string
        id:
          type: integer
        appId:
          type: string
        appInfo:
          type: object
          additionalProperties:
            type: string
        log:
          type: array
          items:
            type: string
  parameters:
    SparkPoolNameParameter:
      name: sparkPoolName
      in: path
      required: true
      description: Name of the Spark pool.
      schema:
        type: string
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
          scopes:
            user_impersonation: impersonate your user account

Azure Synapse Analytics SparkSession API

Documentation

Specifications

Schemas & Data

Other Resources