Azure Synapse Analytics SparkBatch API

openapi: 3.1.0
info:
  title: Azure Synapse Analytics - Access Control AzureADOnlyAuthentications SparkBatch 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: SparkBatch
paths:
  /livyApi/versions/{sparkPoolName}/batches:
    get:
      operationId: SparkBatch_GetSparkBatchJobs
      summary: Azure Synapse Analytics List Spark batch jobs
      description: List all Spark batch jobs running against the Spark pool.
      tags:
      - SparkBatch
      parameters:
      - $ref: '#/components/parameters/SparkPoolNameParameter'
      - name: from
        in: query
        description: Optional param specifying which index the list should begin from.
        schema:
          type: integer
      - name: size
        in: query
        description: Optional param specifying the size of the returned list.
        schema:
          type: integer
      - name: detailed
        in: query
        description: Optional query param specifying whether detailed response is returned beyond plain livy.
        schema:
          type: boolean
      responses:
        '200':
          description: Successfully retrieved the list of batch jobs.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SparkBatchJobCollection'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      operationId: SparkBatch_CreateSparkBatchJob
      summary: Azure Synapse Analytics Create a Spark batch job
      description: Create new Spark batch job.
      tags:
      - SparkBatch
      parameters:
      - $ref: '#/components/parameters/SparkPoolNameParameter'
      - name: detailed
        in: query
        schema:
          type: boolean
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SparkBatchJobOptions'
      responses:
        '200':
          description: Successfully created the batch job.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SparkBatchJob'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /livyApi/versions/{sparkPoolName}/batches/{batchId}:
    get:
      operationId: SparkBatch_GetSparkBatchJob
      summary: Azure Synapse Analytics Get a Spark batch job
      description: Gets a single Spark batch job.
      tags:
      - SparkBatch
      parameters:
      - $ref: '#/components/parameters/SparkPoolNameParameter'
      - name: batchId
        in: path
        required: true
        description: Identifier for the batch job.
        schema:
          type: integer
      - name: detailed
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: Successfully retrieved the batch job.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SparkBatchJob'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      operationId: SparkBatch_CancelSparkBatchJob
      summary: Azure Synapse Analytics Cancel a Spark batch job
      description: Cancels a running Spark batch job.
      tags:
      - SparkBatch
      parameters:
      - $ref: '#/components/parameters/SparkPoolNameParameter'
      - name: batchId
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Successfully cancelled the batch job.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    SparkBatchJob:
      type: object
      properties:
        livyInfo:
          type: object
          properties:
            currentState:
              type: string
        name:
          type: string
        workspaceName:
          type: string
        sparkPoolName:
          type: string
        submitterName:
          type: string
        submitterId:
          type: string
        artifactId:
          type: string
        jobType:
          type: string
          enum:
          - SparkBatch
          - SparkSession
        result:
          type: string
          enum:
          - Uncertain
          - Succeeded
          - Failed
          - Cancelled
        state:
          type: string
          description: The batch state.
        id:
          type: integer
        appId:
          type: string
        appInfo:
          type: object
          additionalProperties:
            type: string
        log:
          type: array
          items:
            type: string
    SparkBatchJobOptions:
      type: object
      required:
      - name
      - file
      properties:
        name:
          type: string
          description: The name of the batch job.
        file:
          type: string
          description: File containing the application to execute.
        className:
          type: string
          description: Main class for Java/Scala applications.
        args:
          type: array
          items:
            type: string
        jars:
          type: array
          items:
            type: string
        pyFiles:
          type: array
          items:
            type: string
        files:
          type: array
          items:
            type: string
        archives:
          type: array
          items:
            type: string
        conf:
          type: object
          additionalProperties:
            type: string
        driverMemory:
          type: string
        driverCores:
          type: integer
        executorMemory:
          type: string
        executorCores:
          type: integer
        executorCount:
          type: integer
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
    SparkBatchJobCollection:
      type: object
      properties:
        from:
          type: integer
        total:
          type: integer
        sessions:
          type: array
          items:
            $ref: '#/components/schemas/SparkBatchJob'
  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